{ "swagger":"2.0", "info":{ "version":"2021.03.17", "title":" REST API for Oracle WebCenter Portal ", "description":" Oracle WebCenter Portal Rest API enable portal users/developers to manage Portal resources. ", "x-summary":"Oracle WebCenter Portal Rest API enable portal users/developers to manage Portal resources." }, "basePath":"", "schemes":[ "http" ], "paths":{ "/v1/portal/portaltemplates":{ "get":{ "tags":[ "portalTemplates" ], "summary":"Retrieve Portal Templates", "description":"Returns information about the portal templates based on the specified query. Note: when search criteria is omitted, returns all the available portal templates.", "operationId":"getPortalTemplates", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:portaltemplate", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"the attribute by which to order the returned objects", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"the maximum number of returned items", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"the position of the first item in result set", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "200":{ "description":"success", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/portalTemplates" } } }, "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portaltemplates-get", "x-filename-id":"v1-portal-portaltemplates-get" } }, "/v1/portal/portaltemplates/{id}":{ "get":{ "tags":[ "portalTemplates" ], "summary":"Retrieve Portal Templates Details by Short ID", "description":"Returns information about the portal template based on the specified short ID", "operationId":"getPortalTemplate", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"the short id of the portal template to be returned", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"if a reduced number of fields should be displayed", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"if child nodes should be expanded", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "404":{ "description":"Invalid short id supplied" } }, "x-internal-id":"v1-portal-portaltemplates-{id}-get", "x-filename-id":"v1-portal-portaltemplates-id-get" } }, "/lists/({compoundId: .+})":{ "get":{ "tags":[ "lists" ], "summary":"Retrieve list by compound ID", "description":"e.g. /oracle/webcenter/list/scopedMD/sc22bfcd1_49ed_46f6_a718_4ad81c52951d/lists/ls_6021370b_c953_41da_8c66_b3cfac792866.xml", "operationId":"getList", "produces":[ "application/json" ], "parameters":[ { "name":"compoundId", "in":"path", "description":"Compound ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/list" } }, "404":{ "description":"ID for the portal or list is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"lists-({compoundId: .+})-get", "x-filename-id":"lists-compoundid-get" } }, "/spaces/{spacename}/lists":{ "get":{ "tags":[ "lists" ], "summary":"Retrieves lists in a portal based on search criteria", "description":"Returns all the available list based on the specified search criteria", "operationId":"getCollection", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"projection", "in":"query", "description":"Projection parameters", "required":false, "type":"string" }, { "name":"q", "in":"query", "description":"Parameters to use for search", "required":false, "type":"string" }, { "name":"startIndex", "in":"query", "description":"Start index", "required":false, "type":"integer", "default":0 }, { "name":"itemsPerPage", "in":"query", "description":"Number of items per page", "required":false, "type":"integer", "default":10 } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/lists" } }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-get", "x-filename-id":"spaces-spacename-lists-get" }, "post":{ "tags":[ "lists" ], "summary":"Create list", "description":"Creates a list", "operationId":"createList", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"List data", "required":true, "schema":{ "$ref":"#/definitions/list" } } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/list" } }, "201":{ "description":"List successfully created" }, "400":{ "description":"ID for the portal or list is invalid" }, "422":{ "description":"Data in the specified list is invalid" }, "500":{ "description":"List cannot be created" } }, "x-internal-id":"spaces-{spacename}-lists-post", "x-filename-id":"spaces-spacename-lists-post" } }, "/spaces/{spacename}/lists/({id: .+})":{ "get":{ "tags":[ "lists" ], "summary":"Retrieve list by ID", "description":"Retrieves the available list based on the specified ID", "operationId":"getList", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"id", "in":"path", "description":"List ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/list" } }, "404":{ "description":"ID for the portal, list, or column is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({id: .+})-get", "x-filename-id":"spaces-spacename-lists-id-get" }, "put":{ "tags":[ "lists" ], "summary":"Updates a list definition", "description":"in a list", "operationId":"updateList", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"id", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"List data", "required":true, "schema":{ "$ref":"#/definitions/list" } } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/list" } }, "404":{ "description":"ID for the portal or list is invalid" }, "422":{ "description":"Data in the specified list is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({id: .+})-put", "x-filename-id":"spaces-spacename-lists-id-put" }, "delete":{ "tags":[ "lists" ], "summary":"Delete list", "description":"Deletes the specified list", "operationId":"deleteList", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"id", "in":"path", "description":"List ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/list" } }, "204":{ "description":"List successfully deleted" }, "404":{ "description":"ID for the portal or list is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({id: .+})-delete", "x-filename-id":"spaces-spacename-lists-id-delete" } }, "/spaces/{spacename}/lists/({id: .+})/rows":{ "get":{ "tags":[ "lists" ], "summary":"Retrieves rows in a list based on search criteria", "description":"Retrieves all the rows in a list based on the specified search criteria", "operationId":"getCollectionrows", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"id", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "name":"q", "in":"query", "description":"Parameters to use for search", "required":false, "type":"string" }, { "name":"startIndex", "in":"query", "description":"Start index", "required":false, "type":"integer", "default":0 }, { "name":"itemsPerPage", "in":"query", "description":"Number of items per page", "required":false, "type":"integer", "default":10 } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/rows" } }, "404":{ "description":"ID for the portal, list, or row is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({id: .+})-rows-get", "x-filename-id":"spaces-spacename-lists-id-rows-get" }, "post":{ "tags":[ "lists" ], "summary":"Create a row in a list", "description":"Creates a row in a list", "operationId":"createRow", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"id", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Row data", "required":true, "schema":{ "$ref":"#/definitions/Row" } } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/Row" } }, "201":{ "description":"Row successfully created" }, "404":{ "description":"ID for the portal, list, or row is invalid" }, "422":{ "description":"Data in the specified list row is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({id: .+})-rows-post", "x-filename-id":"spaces-spacename-lists-id-rows-post" } }, "/spaces/{spacename}/lists/({listid: .+})/columns":{ "get":{ "tags":[ "lists" ], "summary":"Retrieves all columns in a list", "description":"Retrieves all the columns in a specified list", "operationId":"getCollection", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"listid", "in":"path", "description":"List ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"success", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/MetaColumn" } } }, "404":{ "description":"ID for the portal or list is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({listid: .+})-columns-get", "x-filename-id":"spaces-spacename-lists-listid-columns-get" }, "post":{ "tags":[ "lists" ], "summary":"Creates a column in a list", "description":"Creates a new column in a list", "operationId":"createColumn", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"listid", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Column data", "required":true, "schema":{ "$ref":"#/definitions/MetaColumn" } } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/MetaColumn" } }, "404":{ "description":"ID for the portal or list is invalid" }, "422":{ "description":"Data in the specified list column is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({listid: .+})-columns-post", "x-filename-id":"spaces-spacename-lists-listid-columns-post" } }, "/spaces/{spacename}/lists/({listid: .+})/columns/({columnid: .+})":{ "get":{ "tags":[ "lists" ], "summary":"Retrieve a column in a list", "description":"Returns the information of a speciified column in a list", "operationId":"getOne", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"listid", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "name":"columnid", "in":"path", "description":"Column ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/MetaColumn" } }, "404":{ "description":"ID for the portal, list, or column is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({listid: .+})-columns-({columnid: .+})-get", "x-filename-id":"spaces-spacename-lists-listid-columns-columnid-get" }, "put":{ "tags":[ "lists" ], "summary":"Updates a column in a list", "description":"Updates the column in a list", "operationId":"updateColumn", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"listid", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "name":"columnid", "in":"path", "description":"Column ID", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Column updated data", "required":true, "schema":{ "$ref":"#/definitions/MetaColumn" } } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/MetaColumn" } }, "404":{ "description":"ID for the portal, list, or column is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({listid: .+})-columns-({columnid: .+})-put", "x-filename-id":"spaces-spacename-lists-listid-columns-columnid-put" }, "delete":{ "tags":[ "lists" ], "summary":"Delete a column in a list", "description":"Deletes a specified column in a list.", "operationId":"deleteColumn", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"listid", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "name":"columnid", "in":"path", "description":"Column ID", "required":true, "type":"string" } ], "responses":{ "204":{ "description":"Column deleted" }, "404":{ "description":"ID for the portal, list, or column is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({listid: .+})-columns-({columnid: .+})-delete", "x-filename-id":"spaces-spacename-lists-listid-columns-columnid-delete" } }, "/spaces/{spacename}/lists/({listid: .+})/rows/({rowid: .+})":{ "get":{ "tags":[ "lists" ], "summary":"Retrieves a row in a list", "description":"Retrieves a row information from a list", "operationId":"getOne", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"listid", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "name":"rowid", "in":"path", "description":"Row ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/Row" } }, "404":{ "description":"ID for the portal, list, or row is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({listid: .+})-rows-({rowid: .+})-get", "x-filename-id":"spaces-spacename-lists-listid-rows-rowid-get" }, "put":{ "tags":[ "lists" ], "summary":"Updates a row in a list", "operationId":"updateRow", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"listid", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "name":"rowid", "in":"path", "description":"Row ID", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Row data", "required":true, "schema":{ "$ref":"#/definitions/Row" } } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/Row" } }, "404":{ "description":"ID for the portal, list, or row is invalid" }, "422":{ "description":"Data in the specified list row is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({listid: .+})-rows-({rowid: .+})-put", "x-filename-id":"spaces-spacename-lists-listid-rows-rowid-put" }, "delete":{ "tags":[ "lists" ], "summary":"Deletes a row in a list", "description":"Deletes the specified row in a list", "operationId":"deleteRow", "produces":[ "application/json" ], "parameters":[ { "name":"spacename", "in":"path", "description":"Name of the portal", "required":true, "type":"string" }, { "name":"listid", "in":"path", "description":"List ID", "required":true, "type":"string" }, { "name":"rowid", "in":"path", "description":"Row ID", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/Row" } }, "204":{ "description":"Row successfully deleted" }, "404":{ "description":"ID for the portal, list, or row is invalid" }, "500":{ "description":"Specified List is unavailable for this portal" } }, "x-internal-id":"spaces-{spacename}-lists-({listid: .+})-rows-({rowid: .+})-delete", "x-filename-id":"spaces-spacename-lists-listid-rows-rowid-delete" } }, "/v1/portal/skins":{ "get":{ "tags":[ "skins" ], "summary":"Retrieve all Skins", "description":"Returns all available skins and supports paging and response size", "operationId":"getSkins", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"You can use this query parameter to filter the retrieved items based on a search parameter. ", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"You can use this parameter to sort the retrieved items in ascending or descending order.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"You can use this query parameter to specify the maximum number of retrieved items per page in the response body.", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"You can use this query parameter to specify the position of the first retrieved item.", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-skins-get", "x-filename-id":"v1-portal-skins-get" }, "post":{ "tags":[ "skins" ], "summary":"Upload Skin metadata file", "description":"Uploads the metadata files of a specified skin. The meta data file must be posted to the URI for a specific task", "operationId":"uploadSkin", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Specifies the content of the skin metadata file.", "required":true, "schema":{ "$ref":"#/definitions/MultiPart" } } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-skins-post", "x-filename-id":"v1-portal-skins-post" } }, "/v1/portal/skins/{id}":{ "get":{ "tags":[ "skins" ], "summary":"Retrieve Skin Details by Short ID", "description":"Returns information about the skin by Short ID", "operationId":"getSkin", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Specifies the short ID of the skin to be returned.", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"Used to retrieve reduced number of fields.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Used to expand the child nodes.", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-skins-{id}-get", "x-filename-id":"v1-portal-skins-id-get" }, "put":{ "tags":[ "skins" ], "summary":"Update skin given its short ID", "description":"Returns the updated skin", "operationId":"updateSkin", "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Specifies the content of the skin to be updated.", "required":true, "schema":{ "$ref":"#/definitions/skin" } }, { "name":"id", "in":"path", "description":"The short ID of the skin to be updated.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "405":{ "description":"Method not allowed: request does not contain matching currentVersionId" } }, "x-internal-id":"v1-portal-skins-{id}-put", "x-filename-id":"v1-portal-skins-id-put" } }, "/v1/portal/skins/{id}/archive":{ "get":{ "tags":[ "skins" ], "summary":"Download skin", "description":"Downloads the skin from an EAR file", "operationId":"downloadSkin", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"The short ID of the skin to be downloaded.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-skins-{id}-archive-get", "x-filename-id":"v1-portal-skins-id-archive-get" } }, "/cmis/typebyid{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Retrieve Type Definition for the Repository", "description":"Returns the type definitions for the specified repository.", "operationId":"getTypeById", "parameters":[ { "name":"repositoryId", "in":"path", "description":"Repository ID", "required":true, "type":"string" }, { "name":"id", "in":"query", "description":"ID", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-typebyid{repositoryId}-get", "x-filename-id":"cmis-typebyidrepositoryid-get" } }, "/cmis/nestedProperties{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Returns the nested properties of the specified object", "description":"", "operationId":"getNestedProperties", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-nestedProperties{repositoryId}-get", "x-filename-id":"cmis-nestedpropertiesrepositoryid-get" } }, "/cmis/typesDescendants{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Returns the set of descendant object types defined for the specified repository", "description":"", "operationId":"getDescendantTypes", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"includePropertyDefinitions", "in":"query", "required":false, "type":"string" }, { "name":"depth", "in":"query", "required":false, "type":"integer" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-typesDescendants{repositoryId}-get", "x-filename-id":"cmis-typesdescendantsrepositoryid-get" } }, "/cmis/typesChildren{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Returns the list of object types defined for the specified repository", "description":"", "operationId":"getChildTypes", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"typeId", "in":"query", "required":false, "type":"string" }, { "name":"includePropertyDefinitions", "in":"query", "required":false, "type":"string" }, { "name":"maxItems", "in":"query", "required":false, "type":"integer" }, { "name":"skipCount", "in":"query", "required":false, "type":"integer" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-typesChildren{repositoryId}-get", "x-filename-id":"cmis-typeschildrenrepositoryid-get" } }, "/cmis/document{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Gets the list of properties of a document", "description":"", "operationId":"getProperties", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"filter", "in":"query", "required":false, "type":"string" }, { "name":"includeAllowableActions", "in":"query", "required":false, "type":"string" }, { "name":"includeRelationships", "in":"query", "required":false, "type":"string" }, { "name":"includePolicyIds", "in":"query", "required":false, "type":"string" }, { "name":"includeACL", "in":"query", "required":false, "type":"string" }, { "name":"renditionFilter", "in":"query", "required":false, "type":"string" }, { "name":"returnVersion", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-document{repositoryId}-get", "x-filename-id":"cmis-documentrepositoryid-get" }, "post":{ "tags":[ "cmis" ], "summary":"Delete Document using POST", "description":"Deletes the document from the specified repository.", "operationId":"postToDelete", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"_method", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-document{repositoryId}-post", "x-filename-id":"cmis-documentrepositoryid-post" }, "put":{ "tags":[ "cmis" ], "summary":"Update Document Properties", "description":"Updates the properties of a document", "operationId":"updateProperties", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-document{repositoryId}-put", "x-filename-id":"cmis-documentrepositoryid-put" }, "delete":{ "tags":[ "cmis" ], "summary":"Delete Document", "description":"Deletes the document from the specified repository.", "operationId":"delete", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-document{repositoryId}-delete", "x-filename-id":"cmis-documentrepositoryid-delete" } }, "/cmis/folder{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Retrieve Folder Properties", "description":"Returns information/properties of a folder.", "operationId":"getProperties", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"filter", "in":"query", "required":false, "type":"string" }, { "name":"includeAllowableActions", "in":"query", "required":false, "type":"string" }, { "name":"renditionFilter", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-folder{repositoryId}-get", "x-filename-id":"cmis-folderrepositoryid-get" }, "post":{ "tags":[ "cmis" ], "summary":"Delete Folder using POST", "description":"Deletes the folder from the specified repository", "operationId":"postToDelete", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"_method", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-folder{repositoryId}-post", "x-filename-id":"cmis-folderrepositoryid-post" }, "put":{ "tags":[ "cmis" ], "summary":"Update Folder Properties", "description":"Updates the properties of a folder", "operationId":"updateProperties", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-folder{repositoryId}-put", "x-filename-id":"cmis-folderrepositoryid-put" }, "delete":{ "tags":[ "cmis" ], "summary":"Delete Folder", "description":"Deletes the folder from the specified repository", "operationId":"delete", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-folder{repositoryId}-delete", "x-filename-id":"cmis-folderrepositoryid-delete" } }, "/cmis/descendants{repositoryId}":{ "delete":{ "tags":[ "cmis" ], "summary":"Deletes the children of the specified folder", "description":"", "operationId":"delete", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"allVersions", "in":"query", "required":false, "type":"string" }, { "name":"continueOnFailure", "in":"query", "required":false, "type":"string" }, { "name":"unfileObjects", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-descendants{repositoryId}-delete", "x-filename-id":"cmis-descendantsrepositoryid-delete" } }, "/cmis/objectbypath{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Retrieve Object by Path", "description":"Returns all the object based on the specified path.", "operationId":"getObject", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"path", "in":"query", "required":false, "type":"string" }, { "name":"filter", "in":"query", "required":false, "type":"string" }, { "name":"includeAllowableActions", "in":"query", "required":false, "type":"string" }, { "name":"includeRelationships", "in":"query", "required":false, "type":"string" }, { "name":"includePolicyIds", "in":"query", "required":false, "type":"string" }, { "name":"includeACL", "in":"query", "required":false, "type":"string" }, { "name":"renditionFilter", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-objectbypath{repositoryId}-get", "x-filename-id":"cmis-objectbypathrepositoryid-get" } }, "/cmis/parents{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Retrieve Parent Node", "description":"Returns the name of the parent for the specified node.", "operationId":"getParents", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"filter", "in":"query", "required":false, "type":"string" }, { "name":"includeAllowableActions", "in":"query", "required":false, "type":"string" }, { "name":"includeRelationships", "in":"query", "required":false, "type":"string" }, { "name":"renditionFilter", "in":"query", "required":false, "type":"string" }, { "name":"includeRelativePathSegment", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-parents{repositoryId}-get", "x-filename-id":"cmis-parentsrepositoryid-get" } }, "/cmis/query/q{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Queries a service document for the specified repository", "description":"", "operationId":"query", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"searchAllVersions", "in":"query", "required":false, "type":"string" }, { "name":"includeAllowableActions", "in":"query", "required":false, "type":"string" }, { "name":"includeRelationships", "in":"query", "required":false, "type":"string" }, { "name":"maxItems", "in":"query", "required":false, "type":"integer" }, { "name":"skipCount", "in":"query", "required":false, "type":"integer" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-query-q{repositoryId}-get", "x-filename-id":"cmis-query-qrepositoryid-get" } }, "/cmis/children{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Retrieve Child Objects", "description":"Returns a list of child objects for the specified repository.", "operationId":"getChildren", "parameters":[ { "name":"repositoryId", "in":"path", "description":"Repository ID", "required":true, "type":"string" }, { "name":"uid", "in":"query", "description":"uid", "required":false, "type":"string" }, { "name":"filter", "in":"query", "description":"filter", "required":false, "type":"string" }, { "name":"includeAllowableActions", "in":"query", "description":"includeAllowableActions", "required":false, "type":"string" }, { "name":"includeRelationships", "in":"query", "description":"includeRelationships", "required":false, "type":"string" }, { "name":"renditionFilter", "in":"query", "description":"renditionFilter", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"orderBy", "required":false, "type":"string" }, { "name":"maxItems", "in":"query", "description":"maxItems", "required":false, "type":"integer" }, { "name":"skipCount", "in":"query", "description":"skipCount", "required":false, "type":"integer" }, { "name":"includePathSegment", "in":"query", "description":"includePathSegment", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-children{repositoryId}-get", "x-filename-id":"cmis-childrenrepositoryid-get" }, "post":{ "tags":[ "cmis" ], "summary":"Creates a child object in the specified repository", "description":"", "operationId":"create", "consumes":[ "multipart/form-data" ], "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-children{repositoryId}-post", "x-filename-id":"cmis-childrenrepositoryid-post" } }, "/cmis/repository":{ "get":{ "tags":[ "cmis" ], "summary":"Returns a list of available CMIS repositories", "description":"Returns a list of all available CMIS respositories", "operationId":"getRepositories", "parameters":[ { "name":"repositoryId", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-repository-get", "x-filename-id":"cmis-repository-get" } }, "/cmis/nestedProperty{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Returns the nested property of the specified object", "description":"", "operationId":"getNestedProperty", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-nestedProperty{repositoryId}-get", "x-filename-id":"cmis-nestedpropertyrepositoryid-get" } }, "/cmis/objectbyid":{ "get":{ "tags":[ "cmis" ], "summary":"Retrieve Object by ID", "description":"Returns all the object based on the specified ID.", "operationId":"getObject", "parameters":[ { "name":"id", "in":"query", "description":"Id", "required":true, "type":"string" }, { "name":"filter", "in":"query", "description":"Filter", "required":false, "type":"string" }, { "name":"includeAllowableActions", "in":"query", "description":"includeAllowableActions", "required":false, "type":"string" }, { "name":"includeRelationships", "in":"query", "description":"includeRelationships", "required":false, "type":"string" }, { "name":"includePolicyIds", "in":"query", "description":"includePolicyIds", "required":false, "type":"string" }, { "name":"includeACL", "in":"query", "description":"includeACL", "required":false, "type":"string" }, { "name":"renditionFilter", "in":"query", "description":"renditionFilter", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-objectbyid-get", "x-filename-id":"cmis-objectbyid-get" } }, "/cmis/stream{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Retrieve Content Stream for an Object", "description":"Returns the Content Stream for the specified object", "operationId":"getContentStream", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"Range", "in":"header", "required":false, "type":"string" }, { "name":"streamId", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-stream{repositoryId}-get", "x-filename-id":"cmis-streamrepositoryid-get" }, "post":{ "tags":[ "cmis" ], "summary":"Create Content Stream for the specified object", "description":"Creates a content stream for the specified object", "operationId":"postTunnelContentStream", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"Slug", "in":"header", "required":false, "type":"string" }, { "name":"overwriteFlag", "in":"query", "required":false, "type":"string" }, { "name":"fileName", "in":"query", "required":false, "type":"string" }, { "name":"comments", "in":"query", "required":false, "type":"string" }, { "name":"_method", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-stream{repositoryId}-post", "x-filename-id":"cmis-streamrepositoryid-post" }, "put":{ "tags":[ "cmis" ], "summary":"Set Content Stream for an object", "description":"Sets the content stream for the specified object", "operationId":"setContentStream", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" }, { "name":"Slug", "in":"header", "required":false, "type":"string" }, { "name":"overwriteFlag", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-stream{repositoryId}-put", "x-filename-id":"cmis-streamrepositoryid-put" } }, "/cmis/repository{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Returns information about a CMIS repository", "description":"", "operationId":"getRepositoryInfo", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"repositoryId", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-repository{repositoryId}-get", "x-filename-id":"cmis-repositoryrepositoryid-get" } }, "/cmis/type{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Gets the type definitions of specified repository", "description":"", "operationId":"getTypeDefinition", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"uid", "in":"query", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-type{repositoryId}-get", "x-filename-id":"cmis-typerepositoryid-get" } }, "/cmis/query{repositoryId}":{ "post":{ "tags":[ "cmis" ], "summary":"Queries a service document for the specified repository", "description":"", "operationId":"createQueryService", "parameters":[ { "name":"repositoryId", "in":"path", "required":true, "type":"string" }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-query{repositoryId}-post", "x-filename-id":"cmis-queryrepositoryid-post" } }, "/cmis/allowableActions{repositoryId}":{ "get":{ "tags":[ "cmis" ], "summary":"Retrieve Actions for an Object", "description":"Returns a list of actions available for the specified object.", "operationId":"getAllowableActions", "parameters":[ { "name":"repositoryId", "in":"path", "description":"Repository ID", "required":true, "type":"string" }, { "name":"uid", "in":"query", "description":"UID", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"success" } }, "x-internal-id":"cmis-allowableActions{repositoryId}-get", "x-filename-id":"cmis-allowableactionsrepositoryid-get" } }, "/v1/portal/dptaskflows":{ "get":{ "tags":[ "dptaskflows" ], "summary":"Retrieve DP TaskFlow ", "description":"Returms the available DP task flow.", "operationId":"getDpTaskFlows", "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:portal", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"the attribute by which to order the returned objects", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"the maximum number of returned items", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"the position of the first item in result set", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-dptaskflows-get", "x-filename-id":"v1-portal-dptaskflows-get" }, "post":{ "tags":[ "dptaskflows" ], "summary":"Upload DP Taskflow Metadata file", "description":"Uploads the metadata file to the URL for the specified DP taskflow.", "operationId":"uploadDpTaskFlow", "consumes":[ "multipart/form-data", "application/octet-stream" ], "parameters":[ { "name":"body", "in":"formData", "description":"content of the DP TaskFlow metadata files", "required":true, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-dptaskflows-post", "x-filename-id":"v1-portal-dptaskflows-post" } }, "/v1/portal/dptaskflows/{id}":{ "get":{ "tags":[ "dptaskflows" ], "summary":"Retrieve DP Task Flow Details by Short ID", "description":"Returns the information about the taskflow based on the specified short ID.", "operationId":"getDpTaskFlow", "parameters":[ { "name":"id", "in":"path", "description":"the short id of the DP TaskFlow to be returned", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"if a reduced number of fields should be displayed", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"if child nodes should be expanded", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-dptaskflows-{id}-get", "x-filename-id":"v1-portal-dptaskflows-id-get" } }, "/v1/portal/dptaskflows/{id}/archive":{ "get":{ "tags":[ "dptaskflows" ], "summary":"Download DP TaskFlow", "description":"Downloads the DP Taskflow from an EAR file.", "operationId":"downloadDpTaskFlow", "parameters":[ { "name":"id", "in":"path", "description":"the short id of the DP TaskFlow to be downloaded", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-dptaskflows-{id}-archive-get", "x-filename-id":"v1-portal-dptaskflows-id-archive-get" } }, "/v1/portal/layouts":{ "get":{ "tags":[ "layouts" ], "summary":"Retrieve Layouts", "description":"Returns information about the layout based on the specified short ID.", "operationId":"getLayouts", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:layout", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"The attribute used to order the returned objects.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"The maximum number of returned items.", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"The position of the first item in result set.", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-layouts-get", "x-filename-id":"v1-portal-layouts-get" }, "post":{ "tags":[ "layouts" ], "summary":"Upload Layout Metadata File", "description":"Uploads the metadata file to the URL for a specific layout.", "operationId":"uploadLayoutmeta", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"body", "in":"formData", "description":"Specifies the content of the layout metadata file.", "required":true, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-layouts-post", "x-filename-id":"v1-portal-layouts-post" } }, "/v1/portal/layouts/{id}":{ "get":{ "tags":[ "layouts" ], "summary":"Retrieve Layout Details by Short ID", "description":"Returns information about the layout based on the specified short ID.", "operationId":"getLayout", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"The short ID of the layout to be returned", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"Used to display reduced number of fields.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Used to expand the child nodes.", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-layouts-{id}-get", "x-filename-id":"v1-portal-layouts-id-get" }, "put":{ "tags":[ "layouts" ], "summary":"Update layout by short ID", "description":"Updates the layout based on the specified short ID and returns the updated layout.", "operationId":"updateLayout", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Specifies the content of the layout to be updated.", "required":true, "schema":{ "$ref":"#/definitions/layout" } }, { "name":"id", "in":"path", "description":"Specifies the short ID of the layout to be updated.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "405":{ "description":"Method not allowed: request does not contain matching currentVersionId" } }, "x-internal-id":"v1-portal-layouts-{id}-put", "x-filename-id":"v1-portal-layouts-id-put" } }, "/v1/portal/layouts/{id}/archive":{ "get":{ "tags":[ "layouts" ], "summary":"Download layout", "description":"Downloads the layout from an EAR file.", "operationId":"downloadLayout", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"The short ID of the layout to be downloaded.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-layouts-{id}-archive-get", "x-filename-id":"v1-portal-layouts-id-archive-get" } }, "/preferences/general":{ "get":{ "tags":[ "preferences" ], "summary":"Retrieve General Preference Settings Values", "description":"Returns the current values of the general settings", "operationId":"getGeneralPreferences", "produces":[ "application/json" ], "parameters":[ ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/generalPreferences" } }, "500":{ "description":"The Portal Service is unavailable" } }, "x-internal-id":"preferences-general-get", "x-filename-id":"preferences-general-get" }, "put":{ "tags":[ "preferences" ], "summary":"Provide values for general preference settings", "description":"", "operationId":"setGeneralPreferences", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"The preferences data", "required":false, "schema":{ "$ref":"#/definitions/generalPreferences" } } ], "responses":{ "200":{ "description":"success", "schema":{ "$ref":"#/definitions/generalPreferences" } }, "500":{ "description":"The Portal Service is unavailable" } }, "x-internal-id":"preferences-general-put", "x-filename-id":"preferences-general-put" } }, "/v1/portal/resourcecatalogs":{ "get":{ "tags":[ "resourcecatalogs" ], "summary":"Retrieve Resource Catalogs", "description":"Returns all the available Resource Catalog.", "operationId":"getResourceCatalogs", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:resourcecatalog", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"Specifies the attribute used to order the returned objects.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"Specifies the maximum number of returned items.", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"Specifies the position of the first item in the result.", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-resourcecatalogs-get", "x-filename-id":"v1-portal-resourcecatalogs-get" }, "post":{ "tags":[ "resourcecatalogs" ], "summary":"Upload Resource Catalog metadata file", "description":"Uploads the metadata file of the resource catalog.", "operationId":"uploadResourceCatalog", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"body", "in":"formData", "description":"Specifies the content of the resource catalog metadata file.", "required":true, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-resourcecatalogs-post", "x-filename-id":"v1-portal-resourcecatalogs-post" } }, "/v1/portal/resourcecatalogs/{id}":{ "get":{ "tags":[ "resourcecatalogs" ], "summary":"Retrieve Page Style Details by Short ID", "description":"Returns information about the page style based on the specified short ID", "operationId":"getResourceCatalog", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Specifies the short ID of the page style.", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"Used to retrieve reduced number of fields.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Used to expand the child nodes.", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-resourcecatalogs-{id}-get", "x-filename-id":"v1-portal-resourcecatalogs-id-get" }, "put":{ "tags":[ "resourcecatalogs" ], "summary":"Update Resource Catalog by Short ID", "description":"Updates the resource catalog based on the specified short ID and returns the updated resource catalog", "operationId":"updateResourceCatalog", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Specifies the content of the resource catalog to be updated.", "required":true, "schema":{ "$ref":"#/definitions/resourcecatalog" } }, { "name":"id", "in":"path", "description":"The short ID of the resource catalog to be updated.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "405":{ "description":"Method not allowed: request does not contain matching currentVersionId" } }, "x-internal-id":"v1-portal-resourcecatalogs-{id}-put", "x-filename-id":"v1-portal-resourcecatalogs-id-put" } }, "/v1/portal/resourcecatalogs/{id}/archive":{ "get":{ "tags":[ "resourcecatalogs" ], "summary":"Download Resource Catalog", "description":"Downloads the specified resource catalog from the EAR file", "operationId":"downloadResourceCatalog", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"The short ID of the resource catalog to be downloaded.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-resourcecatalogs-{id}-archive-get", "x-filename-id":"v1-portal-resourcecatalogs-id-archive-get" } }, "/v1/portal/portals/{portalId}":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Portal Details by Short ID", "description":"Returns information about the portal based on the specified short ID", "operationId":"getPortal", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"the short id of the portal to be returned", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"if a reduced number of fields should be displayed", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"if child nodes should be expanded", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "404":{ "description":"Invalid short id supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-get", "x-filename-id":"v1-portal-portals-portalid-get" }, "put":{ "tags":[ "portals" ], "summary":"Update Portal by Short ID", "description":"Update the portal based on the specified short ID and returns the information about the updated portal", "operationId":"updatePortal", "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"content of the portal to be updated", "required":true, "schema":{ "$ref":"#/definitions/portal" } }, { "name":"id", "in":"path", "description":"The short id of the portal to be updated", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "405":{ "description":"Method not allowed: request does not contain matching currentVersionId" } }, "x-internal-id":"v1-portal-portals-{portalId}-put", "x-filename-id":"v1-portal-portals-portalid-put" }, "delete":{ "tags":[ "portals" ], "summary":"Delete a Portal", "description":"Deletes a portal.

A portal manager can delete the portal. Deleting a portal is permanent; it cannot be restored after it is deleted.

", "operationId":"deletePortal", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "description":"The short id of the portal.", "required":true, "type":"string" } ], "responses":{ "204":{ "description":"Portal successfully deleted. " }, "404":{ "description":"ID for the portal is invalid" } }, "x-internal-id":"v1-portal-portals-{portalId}-delete", "x-filename-id":"v1-portal-portals-portalid-delete" } }, "/v1/portal/portals/{portalId}/pages":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Pages of a Portal", "description":"Returns information about the pages of a portal in a list wrapper", "operationId":"getSubPages", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "description":"The short id of the portal to use as a parent of the page", "required":true, "type":"string" }, { "name":"q", "in":"query", "description":"search criteria", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"order by", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"the maximum number of returned items", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"the position of the first item in result set", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "404":{ "description":"Invalid portal short id supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-pages-get", "x-filename-id":"v1-portal-portals-portalid-pages-get" }, "post":{ "tags":[ "portals" ], "summary":"Create Page in a Portal by Short ID", "description":"Creates a page in a Portal based on the specified short ID", "operationId":"addSubPage", "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/page" } }, { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-pages-post", "x-filename-id":"v1-portal-portals-portalid-pages-post" } }, "/v1/portal/portals/{portalId}/pagetemplates":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Page Templates of a Portal", "description":"Returns matching page templates within a List wrapper", "operationId":"getSubPageTemplates", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-pagetemplates-get", "x-filename-id":"v1-portal-portals-portalid-pagetemplates-get" }, "post":{ "tags":[ "portals" ], "summary":"Create Page Template for a Portal", "description":"Creates a page template as a subresource of a portal and returns information about the new page template", "operationId":"addSubPageTemplate", "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/pagetemplate" } }, { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-pagetemplates-post", "x-filename-id":"v1-portal-portals-portalid-pagetemplates-post" } }, "/v1/portal/navigationnodes/{id}/childNodes":{ "get":{ "tags":[ "navigationnodes" ], "summary":"Retrieve Child Node for a Navigation Node", "description":"Returns all the available child nodes of a navigation node based on the specified short ID.", "operationId":"getChildNodes", "parameters":[ { "name":"id", "in":"path", "description":"the short id of the parent node whose child nodes are to be returned", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation" }, "403":{ "description":"Invalid utoken supplied" }, "404":{ "description":"Invalid short id supplied" } }, "x-internal-id":"v1-portal-navigationnodes-{id}-childNodes-get", "x-filename-id":"v1-portal-navigationnodes-id-childnodes-get" }, "post":{ "tags":[ "navigationnodes" ], "summary":"Add Child Node To The Navigation Node", "description":"This API inserts a child node under a Parent Navigation Node.
", "operationId":"addChildNode", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"The short id of the parent navigation node under which the child node will be added to", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Reference of the child node to be added", "required":true, "schema":{ "$ref":"#/definitions/navigationnode" } } ], "responses":{ "400":{ "description":"Bad request: ill-formatted content in request" }, "403":{ "description":"Invalid utoken supplied" }, "404":{ "description":"Invalid short id supplied" } }, "x-internal-id":"v1-portal-navigationnodes-{id}-childNodes-post", "x-filename-id":"v1-portal-navigationnodes-id-childnodes-post" } }, "/v1/portal/navigationnodes/{id}/childNodes/{nodeId}":{ "get":{ "tags":[ "navigationnodes" ], "summary":"Retrieve Child Node", "description":"Returns the specified child node", "operationId":"getChildNode", "parameters":[ { "name":"id", "in":"path", "description":"the short id of the parent node ", "required":true, "type":"string" }, { "name":"nodeId", "in":"path", "description":"the id of the child node to be returned", "required":true, "type":"string" }, { "name":"expand", "in":"query", "description":"if child nodes should be expanded", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"successful operation" }, "403":{ "description":"Invalid utoken supplied" }, "404":{ "description":"Invalid id supplied" } }, "x-internal-id":"v1-portal-navigationnodes-{id}-childNodes-{nodeId}-get", "x-filename-id":"v1-portal-navigationnodes-id-childnodes-nodeid-get" }, "delete":{ "tags":[ "navigationnodes" ], "summary":"Remove Child Node", "description":"Removes ths specified child node", "operationId":"removeChildNode", "parameters":[ { "name":"id", "in":"path", "description":"the short id of the parent node whose child node will be removed", "required":true, "type":"string" }, { "name":"nodeId", "in":"path", "description":"the id of the child node to be removed", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "404":{ "description":"Invalid id supplied" }, "204":{ "description":"Node successfully removed" } }, "x-internal-id":"v1-portal-navigationnodes-{id}-childNodes-{nodeId}-delete", "x-filename-id":"v1-portal-navigationnodes-id-childnodes-nodeid-delete" } }, "/v1/portal/portals/{portalId}/pagestyles":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Page Styles of a Portal", "description":"Returns matching page styles within a List wrapper", "operationId":"getPageStyle", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-pagestyles-get", "x-filename-id":"v1-portal-portals-portalid-pagestyles-get" }, "post":{ "tags":[ "portals" ], "summary":"Import page style(s) at portal or shared level", "description":"Imports the specified page style to a portal or shared portal and returns HTTP Status 201 status on successful import", "operationId":"uploadPageStyle", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-pagestyles-post", "x-filename-id":"v1-portal-portals-portalid-pagestyles-post" } }, "/v1/portal/portals/{portalId}/archive":{ "get":{ "tags":[ "portals" ], "summary":"Export Portal to a PAR File", "description":"Exports the specified portal to a PAR file and returns the portal archive with ststus HTTP Status 200 on successful export", "operationId":"exportPortal", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"includePortalContent", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-archive-get", "x-filename-id":"v1-portal-portals-portalid-archive-get" } }, "/v1/portal/members/{memberId}":{ "delete":{ "tags":[ "portals" ], "summary":"Delete a Member", "description":"Deletes a member of a portal.", "operationId":"deleteMember", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"memberId", "in":"path", "description":"The short id of the member.", "required":true, "type":"string" } ], "responses":{ "204":{ "description":"Portal member successfully deleted. " }, "404":{ "description":"ID for the portal member is invalid" } }, "x-internal-id":"v1-portal-members-{memberId}-delete", "x-filename-id":"v1-portal-members-memberid-delete" } }, "/v1/portal/portals/{portalId}/members":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Members of a Portal", "description":"Returns details of members of a portal.", "operationId":"getMembers", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-members-get", "x-filename-id":"v1-portal-portals-portalid-members-get" }, "post":{ "tags":[ "portals" ], "summary":"Add Member to a Portal", "description":"Adds a member to a portal and returns information about the new member. As a portal manager, you can add any user currently registered with Oracle WebCenter Portal as a member of your portal.

The following are the mandatory parameters to add a member: userId and role.

", "operationId":"addMember", "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/member" } }, { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The shortId of the portal." } ], "responses":{ "201":{ "description":"Portal Member added successfully." }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-members-post", "x-filename-id":"v1-portal-portals-portalid-members-post" } }, "/v1/portal/portals/{portalId}/visualizationtemplates":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve visualization templates", "description":"Returns information about the visualization templates of a portal in a list wrapper", "operationId":"getSubVisualizationTemplates", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-visualizationtemplates-get", "x-filename-id":"v1-portal-portals-portalid-visualizationtemplates-get" }, "post":{ "tags":[ "portals" ], "summary":"Import Visualization Template", "description":"Imports the specified visualization template to a portal or shared portal and returns HTTP Status 201 status on successful import", "operationId":"uploadVisualizationTemplate", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-visualizationtemplates-post", "x-filename-id":"v1-portal-portals-portalid-visualizationtemplates-post" } }, "/v1/portal/portals/{portalId}/restdataservices":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve REST DataServices", "description":"Returns information about the REST DataServices of a portal in a list wrapper", "operationId":"getSubRESTDataServices", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-restdataservices-get", "x-filename-id":"v1-portal-portals-portalid-restdataservices-get" } }, "/v1/portal/portals/{portalId}/skins":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Skins", "description":"Returns information about the skins of a portal in a list wrapper", "operationId":"getSkin", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-skins-get", "x-filename-id":"v1-portal-portals-portalid-skins-get" }, "post":{ "tags":[ "portals" ], "summary":"Import Skin", "description":"Imports the specified skin to a portal or shared portal and returns HTTP Status 201 status on successful import", "operationId":"uploadSkin", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-skins-post", "x-filename-id":"v1-portal-portals-portalid-skins-post" } }, "/v1/portal/portals/{portalId}/resourcecatalogs":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Resource Catalog", "description":"Returns information about the resource catalog of a portal in a list wrapper", "operationId":"getResourceCatalog", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-resourcecatalogs-get", "x-filename-id":"v1-portal-portals-portalid-resourcecatalogs-get" }, "post":{ "tags":[ "portals" ], "summary":"Import resource catalog", "description":"Imports the specified resource catalog to a portal or shared portal and returns HTTP Status 201 status on successful import", "operationId":"uploadResourceCatalog", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-resourcecatalogs-post", "x-filename-id":"v1-portal-portals-portalid-resourcecatalogs-post" } }, "/v1/portal/portals/{portalId}/businessobjects":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Data Presenter Business Objects of a Portal", "description":"Returns matching Data Presenter business objects within a List wrapper.", "operationId":"getSubBusinessObjects", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-businessobjects-get", "x-filename-id":"v1-portal-portals-portalid-businessobjects-get" } }, "/v1/portal/portals/{portalId}/dptaskflows":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Data Presenter Taskflows of a Portal", "description":"Returns matching Data Presenter taskflows within a List wrapper", "operationId":"getSubDpTaskFlows", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-dptaskflows-get", "x-filename-id":"v1-portal-portals-portalid-dptaskflows-get" }, "post":{ "tags":[ "portals" ], "summary":"Import Data Presenter Taskflow(s) at Portal or Shared Level", "description":"HTTP Status 201 upon success", "operationId":"uploadDpTaskFlow", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-dptaskflows-post", "x-filename-id":"v1-portal-portals-portalid-dptaskflows-post" } }, "/v1/portal/portals/{portalId}/layouts":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Layouts of a Portal", "description":"Returns matching layouts within a List wrapper", "operationId":"getLayouts", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-layouts-get", "x-filename-id":"v1-portal-portals-portalid-layouts-get" }, "post":{ "tags":[ "portals" ], "summary":"Import Layout(s) at Portal or Shared Level", "description":"HTTP Status 201 upon success", "operationId":"uploadLayout", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-layouts-post", "x-filename-id":"v1-portal-portals-portalid-layouts-post" } }, "/v1/portal/portals":{ "post":{ "tags":[ "portals" ], "summary":"Create a Portal", "description":"Creates a portal and returns information about the newly created portal.

The following are the mandatory parameters to create a portal: name and displayname.

", "operationId":"addPortal", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Content of required attributes of the portal to be created.", "required":true, "schema":{ "$ref":"#/definitions/portal" } } ], "responses":{ "201":{ "description":"Portal created successfully." }, "400":{ "description":"Bad request: ill-formatted content in request." }, "403":{ "description":"Invalid utoken supplied." }, "415":{ "description":"Unsupported media type: request does not contain required media type." } }, "x-internal-id":"v1-portal-portals-post", "x-filename-id":"v1-portal-portals-post" }, "get":{ "tags":[ "portals" ], "summary":"Retrieve Portals", "description":"Returns information about the portal based on the specified query. Note: when search criteria is omitted, returns all the available portal ", "operationId":"getPortals", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"

You can use the query parameter q to filter the retrieved items based on a query object.

The following is the syntax to use the query parameter:

q=QueryObject;queryAttribute:'searchAttribute'

For example: q=DisplayNameQuery;displayName:DemoPortal

  • QueryObject: In this example DisplayNameQuery is used to query. Ensure that you use only the supported QueryObject. See below for the list of supported query objects in WebCenter Portal.
  • queryAttribute: Attributes supported by the specified QueryObject. In this example, displayName is the one of the attributes of DisplayNameQuery. See Java API Reference for Oracle WebCenter Portal for the supported query attributes for the specified QueryObject.
  • searchAttribute: This specifies the value of the queryAttribute. In this example, use the portal displayName, DemoPortal.

The following are the supported queryObjects in WebCenter Portal.

  • DisplayNameQuery: Use this query to search for a particular display name of the portal.

    Example: The following example shows how to search for a portal named HRPortal:

    http://host:port/rest/api/v1/portal/portals?utoken=accesstoken&q=DisplayNameQuery;displayName:HRPortal

  • NameLikeQuery: Use this query to search for a specific name attribute.

    You need to provide the search string to the name attribute, example, HR. If you append the character % with the search string, all the portals which has the word beginning with search string is retrieved:

    Example: The following example shows how to search for the portal name beginning with the word HR:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=NameLikeQuery;name:HR%

  • NameQuery: Use this query to search based on the portal name.

    Provide the complete portal name as the query parameter value.

    Example: The following example shows how to search for the portal name DemoPortal:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&&q=NameQuery;name:DemoPortal

  • DiscoverablePortalQuery: Use this query to retrieve all the discoverable portals that the user is authenticated to view.

    The following example shows how to retrieve all the discoverable portals:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=DiscoverablePortalQuery

  • JoinedPortalQuery: Use this query to retrieve all the portals, which the logged-in user is a member.

    The following example shows how to retrieve all the portals using the JoinedPortalQuery:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=JoinedPortalQuery

  • DefaultPortalQuery: Use this query to retrieve the DefaultGroupSpace available out-of-the-box in Oracle WebCenter Portal.

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=DefaultPortalQuery

  • AllPortalQuery

    In the example, the query returns all those portals, which the logged-in user is a member.

    http://host:port/rest/api/v1/portal/portals?utoken=access_token=AllPortalQuery

  • JoinedOrPublicPortalQuery: Use this query to retrieve all the public portal and the portals, which the logged-in user is a member.

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=JoinedOrPublicPortalQuery

  • PublicPortalQuery: Use this query to retrieve all the Public Portals:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=AllPortalQuery.

    In this example, the admin flag is set to true. This query returns all those portals which the logged-in user is member and also public portals:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=AllPortalQuery;admin:true

  • NameDescriptionLikeQuery: Use this query to retrieve the portal name and description that match the value provided in the queryAttribute name. You can use only one queryAttribute name.

    The following example shows how to query using the NameDescriptionLikeQuery:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=NameDescriptionLikeQuery;name:HR%

    In this example, all the portals whose name or description begins with HR are retrieved.

  • ModeratedPortalQuery: Use this query to retrieve all the portals which the logged-in user is the Moderator.

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=ModeratedPortalQuery

  • NameNamespaceQuery: This query uses two attributes, one name and the other namespace. The namespace can be portal, page, pagestyle and so on. The name parameter takes the portal name as input parameter.

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=NameNamespaceQuery;name:HRPortal;namespace:portal

    In this example, name attribute is used, which is the portal name, HRPortal, and namespace attribute is used as the second attribute and the value provided is portal. This query returns a portal whose portal name matches HRPortal.

  • SinceQuery: Use this query to retrieve all items of a given type modified since a given date. The date should in the following format yyyy-MM-dd'T'HH:mm:ss.SSSX

    For example, SinceQuery;date:2001-07-04T12:08:56.235-0700

    The following example shows how to retrieve all portals modified before the date 2018-11-19T12:08:56.235-0700:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=SinceQuery;date:2018-11-19T12:08:56.235-0700

", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"You can use the orderBy parameter to sort the retrieved items in ascending or descending order.
  • Use asc to sort in ascending order (for example, &orderBy=name:asc)
  • Use desc to sort in descending order (for example, &orderBy=name:desc)

Note:

  • Always use the orderBy query parameter with a QueryObject.
  • The following are the only four attributes that can be used with the orderBy parameter: name, shortId, created and modified.

Example: The following example shows how to use the orderBy parameter to sort the retrieved items for the name attribute in ascending order:

http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=NameLikeQuery;name:HR%&orderBy=name:asc

In this example, the q parameter is q=NameLikeQuery;name:HR%, where the query object is NameLikeQuery and the queryAttribute is name. This query returns all the portals whose name starts with HR and the name attribute is sorted in the ascending order.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"You can use the query parameter limit to specify the maximum number of retrieved items per page in the response body.

The following is the format to set the limit: &limit=number of items per page.

By default, the limit is set to 10 items per page.

Example: This example shows how to set the limit to 5 items per page

http://host:port/rest/api/v1/portal/portals?utoken=access_token&limit=5.

", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"You can use the query parameter offset to specify the position of the first retrieved item.

The following is the format to set the offset: &offset=offset_number

By default, the value of the offset is set to 0.

Example: The following example shows how to set the offset to 5:

http://host:port/rest/api/v1/portal/portals?utoken=access_token&offset=5

", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "200":{ "description":"success", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/portals" } } }, "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-get", "x-filename-id":"v1-portal-portals-get" } }, "/v1/portal/portals/{portalId}/sqldataservices":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve SQL DataServices", "description":"Returns information about the SQL DataServices of a portal in a list wrapper", "operationId":"getSubSQLDataServices", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-sqldataservices-get", "x-filename-id":"v1-portal-portals-portalid-sqldataservices-get" } }, "/v1/portal/portals/{portalId}/contentpresentertemplates":{ "get":{ "tags":[ "portals" ], "summary":"Retrieve Content Presenter Templates of a Portal", "description":"Returns information about the content presenter templates of a portal in a list wrapper", "operationId":"getSubContentPresenterTemplates", "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"q", "in":"query", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "required":false, "type":"string" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"offset", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-contentpresentertemplates-get", "x-filename-id":"v1-portal-portals-portalid-contentpresentertemplates-get" }, "post":{ "tags":[ "portals" ], "summary":"Import Content Presenter Template(s) at Portal or Shared level", "description":"HTTP Status 201 upon success", "operationId":"uploadContentPresenterTemplate", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"portalId", "in":"path", "required":true, "type":"string", "description":"The short Id of a portal." }, { "name":"body", "in":"formData", "required":false, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-portals-{portalId}-contentpresentertemplates-post", "x-filename-id":"v1-portal-portals-portalid-contentpresentertemplates-post" } }, "/v1/portal/restdataservices":{ "get":{ "tags":[ "restdataservices" ], "summary":"Retrieve REST Data Service", "description":"Returns all the available REST DATA Services", "operationId":"getRESTDataServices", "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:portal", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"Specifies the attribute to order the returned objects.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"The maximum number of returned items.", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"The position of the first item in result set.", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-restdataservices-get", "x-filename-id":"v1-portal-restdataservices-get" } }, "/v1/portal/restdataservices/{id}":{ "get":{ "tags":[ "restdataservices" ], "summary":"Retrieve REST Data Service Details by Short ID", "description":"Returns the information about the REST Data service based on the specified short ID", "operationId":"getRESTDataService", "parameters":[ { "name":"id", "in":"path", "description":"The short ID of the REST DataService to be returned.", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"Used to retrieve reduced number of fields.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Used to expand the child nodes.", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-restdataservices-{id}-get", "x-filename-id":"v1-portal-restdataservices-id-get" } }, "/v1/portal/visualizationtemplates":{ "get":{ "tags":[ "visualizationtemplates" ], "summary":"Retrieve all Visualization Templates", "description":"Returns the list of all available visualization templates.", "operationId":"getVisualizationTemplates", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:portal", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"Specifies the attribute used to order the returned.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"Specifies the maximum number of returned items.", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"Specifies the position of the first item in the result.", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-visualizationtemplates-get", "x-filename-id":"v1-portal-visualizationtemplates-get" }, "post":{ "tags":[ "visualizationtemplates" ], "summary":"Create a Visualization Template", "description":"Creates a visualization template.", "operationId":"addVisualizationTemplate", "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Specifies the content of required attributes of the Visualization Template to be created", "required":true, "schema":{ "$ref":"#/definitions/visualizationtemplate" } } ], "responses":{ "400":{ "description":"Bad request: ill-formatted content in request" }, "403":{ "description":"Invalid utoken supplied" }, "415":{ "description":"Unsupported media type: request does not contain required media type" } }, "x-internal-id":"v1-portal-visualizationtemplates-post", "x-filename-id":"v1-portal-visualizationtemplates-post" } }, "/v1/portal/visualizationtemplates/{id}":{ "get":{ "tags":[ "visualizationtemplates" ], "summary":"Retrieve Visualization Template Details by Short ID", "description":"Returns information about the visualization template by short ID.", "operationId":"getVisualizationTemplate", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Specifies the short ID of the Visualization Template to be returned.", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"Used to retrieve reduced number of fields.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Used to expand the child nodes.", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-visualizationtemplates-{id}-get", "x-filename-id":"v1-portal-visualizationtemplates-id-get" }, "put":{ "tags":[ "visualizationtemplates" ], "summary":"Update Visualization Template given its short ID", "description":"Updates the specified visualization templates based on the short ID specified and returns the updated visualization template.", "operationId":"updateVisualizationTemplate", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Specifies the content of the Visualization Template to be updated.", "required":true, "schema":{ "$ref":"#/definitions/visualizationtemplate" } }, { "name":"id", "in":"path", "description":"Specifies the short ID of the Visualization Template to be updated.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "405":{ "description":"Method not allowed: request does not contain matching currentVersionId" } }, "x-internal-id":"v1-portal-visualizationtemplates-{id}-put", "x-filename-id":"v1-portal-visualizationtemplates-id-put" } }, "/v1/portal/visualizationtemplates/{id}/archive":{ "get":{ "tags":[ "visualizationtemplates" ], "summary":"Download Visualization Template", "description":"Downloads a visualization template from an EAR file", "operationId":"downloadVisualizationTemplate", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"the short id of the Visualization Template to be downloaded", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-visualizationtemplates-{id}-archive-get", "x-filename-id":"v1-portal-visualizationtemplates-id-archive-get" } }, "/v1/portal/businessobjects":{ "get":{ "tags":[ "businessobjects" ], "summary":"Retrieve all Business Objects", "description":"Returns all available Business Objects in a Portal.", "operationId":"getBusinessObjects", "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:portal", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"the attribute by which to order the returned objects", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"the maximum number of returned items", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"the position of the first item in result set", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-businessobjects-get", "x-filename-id":"v1-portal-businessobjects-get" } }, "/v1/portal/businessobjects/{id}":{ "get":{ "tags":[ "businessobjects" ], "summary":"Retrieve Business Object Details by Short ID", "description":"Returns information about the Business Objects based on the short ID", "operationId":"getBusinessObject", "parameters":[ { "name":"id", "in":"path", "description":"the short id of the Business Object to be returned", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"if a reduced number of fields should be displayed", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"if child nodes should be expanded", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-businessobjects-{id}-get", "x-filename-id":"v1-portal-businessobjects-id-get" } }, "/v1/portal/pagestyles":{ "get":{ "tags":[ "pagestyles" ], "summary":"Retrieve Page Style", "description":"Returns information about the page styles.", "operationId":"getPageStyles", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:portal", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"Specifies the attribute used to order the returned objects.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"Specifies the maximum number of returned items.", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"Specifies the position of the first item in the result.", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pagestyles-get", "x-filename-id":"v1-portal-pagestyles-get" }, "post":{ "tags":[ "pagestyles" ], "summary":"Upload Page Style Metadata file (page and pageDef)", "description":"must be posted to the URI for a specific page style", "operationId":"uploadPageStylemeta", "consumes":[ "multipart/form-data", "application/octet-stream" ], "produces":[ "application/json" ], "parameters":[ { "name":"body", "in":"formData", "description":"Specifies the content of the page style metadata files.", "required":true, "type":"file" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pagestyles-post", "x-filename-id":"v1-portal-pagestyles-post" } }, "/v1/portal/pagestyles/{id}":{ "get":{ "tags":[ "pagestyles" ], "summary":"Retrieve Page Style Details by Short ID", "description":"Returns information about the page styles based on the specified short ID", "operationId":"getPageStyle", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Specifies the short ID of the page style.", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"Used to retrieve reduced number of fields.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Used to expand the child nodes.", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pagestyles-{id}-get", "x-filename-id":"v1-portal-pagestyles-id-get" }, "put":{ "tags":[ "pagestyles" ], "summary":"Update page style given its short ID", "description":"Returns the updated page style", "operationId":"updatePageStyle", "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"content of the page style to be updated", "required":true, "schema":{ "$ref":"#/definitions/pagestyle" } }, { "name":"id", "in":"path", "description":"the short id of the page style to be updated", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "405":{ "description":"Method not allowed: request does not contain matching currentVersionId" } }, "x-internal-id":"v1-portal-pagestyles-{id}-put", "x-filename-id":"v1-portal-pagestyles-id-put" } }, "/v1/portal/pagestyles/{id}/archive":{ "get":{ "tags":[ "pagestyles" ], "summary":"Download page style", "description":"Downloads the page style from an EAR file.", "operationId":"downloadPageStyle", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Specifies the short ID of page style to be downloaded.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pagestyles-{id}-archive-get", "x-filename-id":"v1-portal-pagestyles-id-archive-get" } }, "/v1/portal/pagestyles/{id}/contentItems":{ "get":{ "tags":[ "pagestyles" ], "summary":"Retrieve Content Items for a Page Style", "description":"Returns the content items for a specified page style", "operationId":"getContentItems", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"the short ID of the page style whose content items are to be returned", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pagestyles-{id}-contentItems-get", "x-filename-id":"v1-portal-pagestyles-id-contentitems-get" } }, "/v1/portal/pages":{ "get":{ "tags":[ "pages" ], "summary":"Retrieve Pages", "description":"Returns all available pages based on the specified query. Supports paging and response size", "operationId":"getPages", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"search criteria", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"Specifies the attribute used to order the returned objects.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"Specifies the maximum number of returned items.", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"Specifies the position of the first item in the result.", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pages-get", "x-filename-id":"v1-portal-pages-get" }, "post":{ "tags":[ "pages" ], "summary":"Create a page", "description":"

Creates a page and returns information about the newly created page.\nNote: After a new page is created, this page has to be inserted into the NavigationNode as a childNode, then only the page will be visible in the Portal

\n\n

To do this follow these steps:\n

  • Query the portal to get the navigationnodes id. Use the REST API, Retrieve Portal Details by Short ID. In the response obtained search for navigationnodes URL, the URL will be something like : \"http://host:port/rest/api/v1/portal/navigationnodes/AjY?utoken=\". \nHere Ajy is the navigationNodeId. Note down this id.
    • \n\n\n
  • Next, insert the navigationNode as the childNode using the REST API Add Child Node To The Navigation Node here id is the navigationNodeId, which we noted down in the earlier step.\n\n

\n\n", "operationId":"addPage", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Content of required attributes of the page to be created.", "required":true, "schema":{ "$ref":"#/definitions/page" } } ], "responses":{ "400":{ "description":"Bad request: ill-formatted content in request" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pages-post", "x-filename-id":"v1-portal-pages-post" } }, "/v1/portal/pages{id}":{ "get":{ "tags":[ "pages" ], "summary":"Retrieve page details by short ID", "description":"Returns information about the page based on the specied short ID", "operationId":"getPage", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"the short id of the page to be returned", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"if a reduced number of fields should be displayed", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"if child nodes should be expanded", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pages{id}-get", "x-filename-id":"v1-portal-pagesid-get" }, "put":{ "tags":[ "pages" ], "summary":"Update Pages by Short ID", "description":"Updates the pages based on the specified Short Id and returns the updates page", "operationId":"updatePage", "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"content of the page to be updated", "required":true, "schema":{ "$ref":"#/definitions/page" } }, { "name":"id", "in":"path", "description":"the short id of the page to be updated", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "405":{ "description":"Method not allowed: request does not contain matching currentVersionId" } }, "x-internal-id":"v1-portal-pages{id}-put", "x-filename-id":"v1-portal-pagesid-put" } }, "/v1/portal/pages{id}/contentItems":{ "get":{ "tags":[ "pages" ], "summary":"Retrieve Content Items for a Page", "description":"Returns the content items for a specified page.", "operationId":"getContentItems", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"The short ID of the page whose content items are to be returned.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pages{id}-contentItems-get", "x-filename-id":"v1-portal-pagesid-contentitems-get" } }, "/v1/portal/pagetemplates":{ "get":{ "tags":[ "pagetemplates" ], "summary":"Retrieve Page Templates", "description":"Supports paging and response size", "operationId":"getPageTemplates", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:pagetemplate", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"The attribute by which to order the returned objects.", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"The maximum number of returned items.", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"The position of the first item in result set.", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pagetemplates-get", "x-filename-id":"v1-portal-pagetemplates-get" }, "post":{ "tags":[ "pagetemplates" ], "summary":"Create Page Template", "description":"Creates a page template and returms the information about the new page template", "operationId":"addPageTemplate", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Specifies the Content of required attributes of the Page Template to be created.", "required":true, "schema":{ "$ref":"#/definitions/pagetemplate" } } ], "responses":{ "400":{ "description":"Bad request: ill-formatted content in request" }, "403":{ "description":"Invalid utoken supplied" }, "415":{ "description":"Unsupported media type: request does not contain required media type" } }, "x-internal-id":"v1-portal-pagetemplates-post", "x-filename-id":"v1-portal-pagetemplates-post" } }, "/v1/portal/pagetemplates/{id}":{ "get":{ "tags":[ "pagetemplates" ], "summary":"Retrieve Page Templates by Short ID", "description":"Returns all the available page templates based on the specified query.", "operationId":"getPageTemplate", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Specifies the short ID of the Page Template to be returned.", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"Used to retrieve reduced number of fields.", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Used to expand the child nodes.", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pagetemplates-{id}-get", "x-filename-id":"v1-portal-pagetemplates-id-get" }, "put":{ "tags":[ "pagetemplates" ], "summary":"Update Page Template by short ID", "description":"Updates page templetes based on the specified short ID and returns the imformation about the updated page template", "operationId":"updatePageTemplate", "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Specifies the content of the Page Template to be updated.", "required":true, "schema":{ "$ref":"#/definitions/pagetemplate" } }, { "name":"id", "in":"path", "description":"The short ID of the Page Template to be updated.", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" }, "405":{ "description":"Method not allowed: request does not contain matching currentVersionId" } }, "x-internal-id":"v1-portal-pagetemplates-{id}-put", "x-filename-id":"v1-portal-pagetemplates-id-put" } }, "/v1/portal/pagetemplates/{id}/archive":{ "get":{ "tags":[ "pagetemplates" ], "summary":"Download Page Template", "description":"Downloads the page template from an EAR file", "operationId":"downloadPageTemplate", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"the short id of the Page Template to be downloaded", "required":true, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-pagetemplates-{id}-archive-get", "x-filename-id":"v1-portal-pagetemplates-id-archive-get" } }, "/v1/portal/sqldataservices":{ "get":{ "tags":[ "sqldataservices" ], "summary":"Retrieve SQL DataService", "description":"Returns all the available SQL data services", "operationId":"getSQLDataServices", "produces":[ "application/json" ], "parameters":[ { "name":"q", "in":"query", "description":"search criteria, example: NameNamespaceQuery;name:;namespace:portal", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"the attribute by which to order the returned objects", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"the maximum number of returned items", "required":false, "type":"integer", "default":10, "format":"int32" }, { "name":"offset", "in":"query", "description":"the position of the first item in result set", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "400":{ "description":"Bad request: invalid search or orderBy parameter supplied" }, "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-sqldataservices-get", "x-filename-id":"v1-portal-sqldataservices-get" } }, "/v1/portal/sqldataservices/{id}":{ "get":{ "tags":[ "sqldataservices" ], "summary":"Retrieve SQL DataService by Short ID", "description":"Returns the information about the SQL Data Service based on the specified short ID.", "operationId":"getSQLDataService", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"the short id of the SQL DataService to be returned", "required":true, "type":"string" }, { "name":"fields", "in":"query", "description":"if a reduced number of fields should be displayed", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"if child nodes should be expanded", "required":false, "type":"string" } ], "responses":{ "403":{ "description":"Invalid utoken supplied" } }, "x-internal-id":"v1-portal-sqldataservices-{id}-get", "x-filename-id":"v1-portal-sqldataservices-id-get" } } }, "definitions":{ "Linked":{ "properties":{ "resourceType":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } } } }, "reflect.Parameter":{ "properties":{ "varArgs":{ "type":"boolean" }, "implicit":{ "type":"boolean" }, "name":{ "type":"string" }, "namePresent":{ "type":"boolean" }, "annotatedType":{ "$ref":"#/definitions/reflect.AnnotatedType" }, "modifiers":{ "type":"integer", "format":"int32" }, "synthetic":{ "type":"boolean" }, "declaringExecutable":{ "$ref":"#/definitions/reflect.Executable" }, "parameterizedType":{ "$ref":"#/definitions/reflect.Type" } } }, "LinkElementState":{ "properties":{ "resourceType":{ "type":"string" }, "root":{ "type":"boolean" }, "path":{ "type":"string" }, "template":{ "type":"boolean" }, "pathLinkValues":{ "type":"array", "items":{ "type":"string" } }, "pathLinkWildcards":{ "type":"array", "items":{ "type":"string" } }, "href":{ "type":"boolean" }, "resourceMethod":{ "$ref":"#/definitions/reflect.Method" } } }, "Locale":{ "properties":{ "iSO3Country":{ "type":"string" }, "country":{ "type":"string" }, "displayCountry":{ "type":"string" }, "displayVariant":{ "type":"string" }, "displayName":{ "type":"string" }, "script":{ "type":"string" }, "iSO3Language":{ "type":"string" }, "displayLanguage":{ "type":"string" }, "unicodeLocaleAttributes":{ "type":"array", "items":{ "type":"string" } }, "unicodeLocaleKeys":{ "type":"array", "items":{ "type":"string" } }, "language":{ "type":"string" }, "variant":{ "type":"string" }, "displayScript":{ "type":"string" } } }, "portalTemplates":{ "properties":{ "items":{ "type":"array", "items":{ "type":"string" } }, "itemsPerPage":{ "type":"integer", "format":"int32" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "portalTemplate":{ "type":"array", "items":{ "$ref":"#/definitions/portal" } }, "resourceType":{ "type":"string" }, "startIndex":{ "type":"integer", "format":"int32" }, "totalResults":{ "type":"integer", "format":"int32" } } }, "reflect.Executable":{ "properties":{ "genericExceptionTypes":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.Type" } }, "genericParameterTypes":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.Type" } }, "varArgs":{ "type":"boolean" }, "annotatedReturnType":{ "$ref":"#/definitions/reflect.AnnotatedType" }, "parameterCount":{ "type":"integer", "format":"int32" }, "annotatedReceiverType":{ "$ref":"#/definitions/reflect.AnnotatedType" }, "name":{ "type":"string" }, "annotatedExceptionTypes":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.AnnotatedType" } }, "accessible":{ "type":"boolean" }, "modifiers":{ "type":"integer", "format":"int32" }, "synthetic":{ "type":"boolean" }, "annotatedParameterTypes":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.AnnotatedType" } }, "parameters":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.Parameter" } }, "typeParameters":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.TypeVariable" } } } }, "QueryParam":{ "properties":{ "value":{ "type":"string" } } }, "reflect.AnnotatedType":{ "properties":{ "type":{ "$ref":"#/definitions/reflect.Type" } } }, "reflect.Method":{ "properties":{ "genericExceptionTypes":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.Type" } }, "genericParameterTypes":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.Type" } }, "varArgs":{ "type":"boolean" }, "annotatedReturnType":{ "$ref":"#/definitions/reflect.AnnotatedType" }, "parameterCount":{ "type":"integer", "format":"int32" }, "annotatedReceiverType":{ "$ref":"#/definitions/reflect.AnnotatedType" }, "bridge":{ "type":"boolean" }, "name":{ "type":"string" }, "annotatedExceptionTypes":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.AnnotatedType" } }, "accessible":{ "type":"boolean" }, "modifiers":{ "type":"integer", "format":"int32" }, "synthetic":{ "type":"boolean" }, "genericReturnType":{ "$ref":"#/definitions/reflect.Type" }, "defaultValue":{ "type":"integer" }, "annotatedParameterTypes":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.AnnotatedType" } }, "parameters":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.Parameter" } }, "typeParameters":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.TypeVariable" } }, "default":{ "type":"boolean" } } }, "reference":{ "properties":{ "name":{ "type":"string", "description":"Name of the Portal", "required":true }, "resourceType":{ "type":"string" }, "namespace":{ "type":"string" }, "portalName":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } } } }, "portal":{ "required":[ "name", "displayName" ], "properties":{ "serviceDataCopied":{ "type":"string" }, "skin":{ "$ref":"#/definitions/Linked" }, "resourceCatalogForGroupSpaceSiteTemplates":{ "$ref":"#/definitions/Linked" }, "selfRegistrationPage":{ "type":"string" }, "enabledTools":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "pageCreationStyle":{ "$ref":"#/definitions/Linked" }, "securitySubscriptionMessagesAddMember":{ "type":"string" }, "workflowApprovalSubscriptionRoleWorkflows":{ "type":"string" }, "logoScaled":{ "type":"string" }, "securitySeededRoles":{ "type":"string" }, "reorderDeviceGroups":{ "type":"boolean" }, "isPublishRSS":{ "type":"boolean" }, "includeMembers":{ "type":"boolean" }, "subGSCount":{ "type":"integer", "format":"int32" }, "isWorkflowApprovalSubscriptionApprovalRequired":{ "type":"boolean" }, "includedServices":{ "type":"array", "items":{ "type":"string" } }, "displayName":{ "type":"string", "description":"Name of the portal as displayed to users.", "required":true }, "shortId":{ "type":"string" }, "securitySeededUsers":{ "type":"string" }, "securityId":{ "type":"string" }, "previewScaled":{ "type":"string" }, "workflowApprovalUnsubscriptionRoleWorkflows":{ "type":"string" }, "loginPage":{ "$ref":"#/definitions/Linked" }, "isWorkflowApprovalSubscriptionEnableAllRoles":{ "type":"boolean" }, "documentRef":{ "type":"string" }, "id":{ "type":"string" }, "privacyPolicyURL":{ "type":"string" }, "pageCreationSettingScheme":{ "type":"string" }, "securitySubscriptionMessagesInviteMember":{ "type":"string" }, "creationStatus":{ "type":"string" }, "navigationRootNode":{ "$ref":"#/definitions/Linked" }, "acronym":{ "type":"string" }, "selfRegistrationDefaultRole":{ "type":"string" }, "isSeeded":{ "type":"boolean" }, "creator":{ "type":"string" }, "name":{ "type":"string", "description":"Name of the portal. Note the name of the portal is without space. For example, HRportal." }, "isWorkflowApprovalUnsubscriptionEnableAllRoles":{ "type":"boolean" }, "locale":{ "$ref":"#/definitions/Locale" }, "isBlockAllAccess":{ "type":"boolean" }, "isDiscoverable":{ "type":"boolean" }, "isClosed":{ "type":"boolean" }, "modifier":{ "type":"string" }, "ancestorPath":{ "type":"string" }, "helpPage":{ "type":"string" }, "keywords":{ "type":"string" }, "reference":{ "$ref":"#/definitions/reference" }, "portalLifecycleStateMode":{ "type":"string" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "includeRoles":{ "type":"boolean" }, "isSelfRegistration":{ "type":"boolean" }, "supportedLanguages":{ "type":"string" }, "offlinePage":{ "$ref":"#/definitions/Linked" }, "portalLifecycleStateLastChangedBy":{ "type":"string" }, "portalLifecycleStateLastChangedDate":{ "type":"string", "format":"date-time" }, "modified":{ "type":"string", "format":"date-time" }, "copyrightMessage":{ "type":"string" }, "securitySubscriptionMessagesInviteNonMember":{ "type":"string" }, "isWorkflowApprovalUnsubscriptionApprovalRequired":{ "type":"boolean" }, "logo":{ "type":"string" }, "javaFormatId":{ "type":"string" }, "isPageCreationSettingInstantCreate":{ "type":"boolean" }, "memberCount":{ "type":"integer", "format":"int32" }, "adminMailingList":{ "type":"string" }, "inviteWebCenterUsersEnabled":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "portalColor":{ "type":"string" }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "preview":{ "type":"string" }, "isPublic":{ "type":"boolean" }, "allMailingList":{ "type":"string" }, "isFooterHidden":{ "type":"boolean" }, "loginFailedPage":{ "$ref":"#/definitions/Linked" }, "iconScaled":{ "type":"string" }, "description":{ "type":"string" }, "applicationID":{ "type":"string" }, "currentVersionId":{ "type":"string" }, "defaultLanguage":{ "type":"string" }, "isOnline":{ "type":"boolean" }, "icon":{ "type":"string" } } }, "link":{ "properties":{ "contentType":{ "type":"string" }, "resourceType":{ "type":"string" }, "type":{ "type":"string" }, "rel":{ "type":"string" }, "href":{ "type":"string" }, "capabilities":{ "type":"string" }, "template":{ "type":"string" }, "title":{ "type":"string" } } }, "reflect.Type":{ "properties":{ "typeName":{ "type":"string" } } }, "reflect.TypeVariable":{ "properties":{ "bounds":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.Type" } }, "annotatedBounds":{ "type":"array", "items":{ "$ref":"#/definitions/reflect.AnnotatedType" } }, "name":{ "type":"string" } } }, "list":{ "properties":{ "created":{ "type":"string" }, "columns":{ "$ref":"#/definitions/MetaColumns" }, "author":{ "$ref":"#/definitions/PersonReference" }, "id":{ "type":"string" }, "modifiedByUser":{ "$ref":"#/definitions/PersonReference" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "modifier":{ "type":"string" }, "scope":{ "type":"string" }, "modified":{ "type":"string" }, "description":{ "type":"string" } } }, "BigInteger":{ "properties":{ "bitCount":{ "type":"integer", "format":"int32" }, "bitLength":{ "type":"integer", "format":"int32" }, "lowestSetBit":{ "type":"integer", "format":"int32" }, "signum":{ "type":"integer", "format":"int32" } } }, "MetaColumns":{ "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/MetaColumn" } }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "resourceType":{ "type":"string" } } }, "lists":{ "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "itemsPerPage":{ "type":"integer" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "resourceType":{ "type":"string" }, "startIndex":{ "type":"integer" }, "totalResults":{ "type":"integer" } } }, "dataColumn":{ "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "value":{ "type":"string" } } }, "PersonReference":{ "properties":{ "displayName":{ "type":"string" }, "guid":{ "type":"string" }, "id":{ "type":"string" } } }, "Row":{ "properties":{ "created":{ "type":"string" }, "columns":{ "type":"array", "items":{ "$ref":"#/definitions/dataColumn" } }, "author":{ "$ref":"#/definitions/PersonReference" }, "id":{ "type":"string" }, "modifiedByUser":{ "$ref":"#/definitions/PersonReference" }, "creator":{ "type":"string" }, "listId":{ "type":"string" }, "modifier":{ "type":"string" }, "scope":{ "type":"string" }, "modified":{ "type":"string" } } }, "BigDecimal":{ "properties":{ "precision":{ "type":"integer", "format":"int32" }, "scale":{ "type":"integer", "format":"int32" } } }, "MetaColumn":{ "properties":{ "hint":{ "type":"string" }, "rangeHigh":{ "$ref":"#/definitions/BigDecimal" }, "id":{ "type":"string" }, "maxLength":{ "$ref":"#/definitions/BigInteger" }, "name":{ "type":"string" }, "linkTarget":{ "type":"string" }, "editLines":{ "$ref":"#/definitions/BigInteger" }, "required":{ "type":"boolean" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "dataType":{ "type":"string" }, "peopleScope":{ "type":"string" }, "allowLinks":{ "type":"boolean" }, "defaultValue":{ "type":"integer" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "resourceType":{ "type":"string" }, "displayWidth":{ "$ref":"#/definitions/BigInteger" }, "displayLength":{ "$ref":"#/definitions/BigInteger" }, "format":{ "type":"string" }, "rangeLow":{ "$ref":"#/definitions/BigDecimal" } } }, "rows":{ "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/Row" } }, "itemsPerPage":{ "type":"integer" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "resourceType":{ "type":"string" }, "startIndex":{ "type":"integer" }, "totalResults":{ "type":"integer" } } }, "skin":{ "properties":{ "translatedDescription":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "descriptionKey":{ "type":"string" }, "usesCustomSecurity":{ "type":"boolean" }, "iconURI":{ "type":"string" }, "displayName":{ "type":"string" }, "shortId":{ "type":"string" }, "securityId":{ "type":"string" }, "documentRef":{ "type":"string" }, "seeded":{ "type":"boolean" }, "id":{ "type":"string" }, "sourceMetadataFilePath":{ "type":"string" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "visible":{ "type":"boolean" }, "excludedPortalIds":{ "type":"string" }, "lockedBy":{ "type":"string" }, "modifier":{ "type":"string" }, "skinFamily":{ "type":"string" }, "skinExtends":{ "type":"string" }, "reference":{ "$ref":"#/definitions/reference" }, "skinId":{ "type":"string" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "contentDir":{ "type":"string" }, "modified":{ "type":"string", "format":"date-time" }, "category":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "displayNameKey":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "logoURL":{ "type":"string" }, "description":{ "type":"string" }, "resourceBundle":{ "type":"string" }, "currentVersionId":{ "type":"string" } } }, "MediaType":{ "properties":{ "type":{ "type":"string" }, "subtype":{ "type":"string" }, "wildcardType":{ "type":"boolean" }, "wildcardSubtype":{ "type":"boolean" } } }, "MultiPart":{ "properties":{ "bodyParts":{ "type":"array", "items":{ "$ref":"#/definitions/BodyPart" } }, "mediaType":{ "$ref":"#/definitions/MediaType" }, "contentDisposition":{ "$ref":"#/definitions/ContentDisposition" }, "parent":{ "$ref":"#/definitions/MultiPart" } } }, "ContentDisposition":{ "properties":{ "type":{ "type":"string" }, "fileName":{ "type":"string" }, "creationDate":{ "type":"string", "format":"date-time" }, "modificationDate":{ "type":"string", "format":"date-time" }, "readDate":{ "type":"string", "format":"date-time" }, "size":{ "type":"integer", "format":"int64" } } }, "BodyPart":{ "properties":{ "mediaType":{ "$ref":"#/definitions/MediaType" }, "parent":{ "$ref":"#/definitions/MultiPart" }, "contentDisposition":{ "$ref":"#/definitions/ContentDisposition" } } }, "EnumIncludeRelationshipsParam":{ "properties":{ "value":{ "type":"string" } } }, "EnumVersioningStateParam":{ "properties":{ "defaultValue":{ "type":"array", "items":{ "type":"string" } }, "value":{ "type":"string" } } }, "DelimitedListParam":{ "properties":{ "value":{ "type":"string" } } }, "EnumReturnVersionParam":{ "properties":{ "defaultValue":{ "type":"string" }, "value":{ "type":"string" } } }, "SearchParam":{ "properties":{ "search":{ "type":"string" } } }, "BooleanParam":{ "properties":{ "value":{ "type":"string" } } }, "IntegerParam":{ "properties":{ "defaultValue":{ "type":"array", "items":{ "type":"integer" } }, "value":{ "type":"string" } } }, "layout":{ "properties":{ "translatedDescription":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "descriptionKey":{ "type":"string" }, "usesCustomSecurity":{ "type":"boolean" }, "iconURI":{ "type":"string" }, "displayName":{ "type":"string" }, "shortId":{ "type":"string" }, "securityId":{ "type":"string" }, "documentRef":{ "type":"string" }, "seeded":{ "type":"boolean" }, "id":{ "type":"string" }, "excludedFrom":{ "type":"string", "enum":[ "EXCLUDED_FROM_HOME_PORTAL", "EXCLUDED_FROM_ALL_PORTALS", "EXCLUDED_FROM_PORTAL_IDS" ] }, "sourceMetadataFilePath":{ "type":"string" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "visible":{ "type":"boolean" }, "sourceJspxFilePath":{ "type":"string" }, "excludedPortalIds":{ "type":"string" }, "lockedBy":{ "type":"string" }, "modifier":{ "type":"string" }, "reference":{ "$ref":"#/definitions/reference" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "contentDir":{ "type":"string" }, "modified":{ "type":"string", "format":"date-time" }, "category":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "jspxPath":{ "type":"string" }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "displayNameKey":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "logoURL":{ "type":"string" }, "description":{ "type":"string" }, "resourceBundle":{ "type":"string" }, "currentVersionId":{ "type":"string" } } }, "generalPreferences":{ "properties":{ "preference":{ "type":"array", "items":{ "$ref":"#/definitions/Preference" } }, "resourceType":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } } } }, "Preference":{ "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" }, "resourceType":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } } } }, "resourcecatalog":{ "properties":{ "translatedDescription":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "descriptionKey":{ "type":"string" }, "usesCustomSecurity":{ "type":"boolean" }, "iconURI":{ "type":"string" }, "displayName":{ "type":"string" }, "shortId":{ "type":"string" }, "securityId":{ "type":"string" }, "documentRef":{ "type":"string" }, "seeded":{ "type":"boolean" }, "id":{ "type":"string" }, "excludedFrom":{ "type":"string", "enum":[ "EXCLUDED_FROM_HOME_PORTAL", "EXCLUDED_FROM_ALL_PORTALS", "EXCLUDED_FROM_PORTAL_IDS" ] }, "sourceMetadataFilePath":{ "type":"string" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "visible":{ "type":"boolean" }, "excludedPortalIds":{ "type":"string" }, "lockedBy":{ "type":"string" }, "modifier":{ "type":"string" }, "reference":{ "$ref":"#/definitions/reference" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "contentDir":{ "type":"string" }, "modified":{ "type":"string", "format":"date-time" }, "category":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "displayNameKey":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "logoURL":{ "type":"string" }, "description":{ "type":"string" }, "resourceBundle":{ "type":"string" }, "currentVersionId":{ "type":"string" } } }, "taskflow":{ "properties":{ "translatedDescription":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "descriptionKey":{ "type":"string" }, "usesCustomSecurity":{ "type":"boolean" }, "iconURI":{ "type":"string" }, "displayName":{ "type":"string" }, "shortId":{ "type":"string" }, "securityId":{ "type":"string" }, "documentRef":{ "type":"string" }, "seeded":{ "type":"boolean" }, "id":{ "type":"string" }, "excludedFrom":{ "type":"string", "enum":[ "EXCLUDED_FROM_HOME_PORTAL", "EXCLUDED_FROM_ALL_PORTALS", "EXCLUDED_FROM_PORTAL_IDS" ] }, "pageDef":{ "type":"string" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "visible":{ "type":"boolean" }, "excludedPortalIds":{ "type":"string" }, "lockedBy":{ "type":"string" }, "modifier":{ "type":"string" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "contentDir":{ "type":"string" }, "modified":{ "type":"string", "format":"date-time" }, "category":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "displayNameKey":{ "type":"string" }, "jspx":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "logoURL":{ "type":"string" }, "description":{ "type":"string" }, "resourceBundle":{ "type":"string" }, "currentVersionId":{ "type":"string" }, "metadataFile":{ "type":"string" } } }, "member":{ "required":[ "userId", "role" ], "properties":{ "userGUID":{ "type":"string" }, "role":{ "type":"string", "description":"The name of the role to be assigned to the portal member." }, "created":{ "type":"string", "format":"date-time" }, "permissionAction":{ "type":"string" }, "groupSpaceType":{ "type":"boolean" }, "shortId":{ "type":"string", "description":"The Id of a portal." }, "securityId":{ "type":"string" }, "permissionName":{ "type":"string" }, "documentRef":{ "type":"string" }, "isGroup":{ "type":"boolean" }, "id":{ "type":"string" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "userId":{ "type":"string", "description":"The name of the portal member. For example, karen." }, "spaceId":{ "type":"string" }, "modifier":{ "type":"string" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "modified":{ "type":"string", "format":"date-time" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "description":{ "type":"string" }, "currentVersionId":{ "type":"string" } } }, "pagestyle":{ "properties":{ "translatedDescription":{ "type":"string" }, "pageViewType":{ "type":"string", "enum":[ "JSF", "JSPX" ] }, "created":{ "type":"string", "format":"date-time" }, "descriptionKey":{ "type":"string" }, "usesCustomSecurity":{ "type":"boolean" }, "iconURI":{ "type":"string" }, "displayName":{ "type":"string" }, "contributionModeAfterCreation":{ "type":"boolean" }, "shortId":{ "type":"string" }, "securityId":{ "type":"string" }, "documentRef":{ "type":"string" }, "seeded":{ "type":"boolean" }, "id":{ "type":"string" }, "excludedFrom":{ "type":"string", "enum":[ "EXCLUDED_FROM_HOME_PORTAL", "EXCLUDED_FROM_ALL_PORTALS", "EXCLUDED_FROM_PORTAL_IDS" ] }, "grantee":{ "type":"string" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "visible":{ "type":"boolean" }, "excludedPortalIds":{ "type":"string" }, "lockedBy":{ "type":"string" }, "modifier":{ "type":"string" }, "qualifier":{ "type":"string" }, "reference":{ "$ref":"#/definitions/reference" }, "editPageAfterCreation":{ "type":"boolean" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "pagePath":{ "type":"string" }, "sourcePath":{ "type":"string" }, "contentDir":{ "type":"string" }, "modified":{ "type":"string", "format":"date-time" }, "inputFileName":{ "type":"string" }, "sourcePageDefinitionPath":{ "type":"string" }, "pageDefinitionPath":{ "type":"string" }, "category":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "displayNameKey":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "logoURL":{ "type":"string" }, "description":{ "type":"string" }, "resourceBundle":{ "type":"string" }, "currentVersionId":{ "type":"string" } } }, "contentpresentertemplate":{ "properties":{ "translatedDescription":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "descriptionKey":{ "type":"string" }, "usesCustomSecurity":{ "type":"boolean" }, "iconURI":{ "type":"string" }, "displayName":{ "type":"string" }, "shortId":{ "type":"string" }, "securityId":{ "type":"string" }, "documentRef":{ "type":"string" }, "seeded":{ "type":"boolean" }, "id":{ "type":"string" }, "excludedFrom":{ "type":"string", "enum":[ "EXCLUDED_FROM_HOME_PORTAL", "EXCLUDED_FROM_ALL_PORTALS", "EXCLUDED_FROM_PORTAL_IDS" ] }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "visible":{ "type":"boolean" }, "sourceJspxFilePath":{ "type":"string" }, "excludedPortalIds":{ "type":"string" }, "lockedBy":{ "type":"string" }, "modifier":{ "type":"string" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "contentDir":{ "type":"string" }, "modified":{ "type":"string", "format":"date-time" }, "category":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "jspxPath":{ "type":"string" }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "displayNameKey":{ "type":"string" }, "jspx":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "logoURL":{ "type":"string" }, "description":{ "type":"string" }, "resourceBundle":{ "type":"string" }, "currentVersionId":{ "type":"string" } } }, "pagetemplate":{ "properties":{ "translatedDescription":{ "type":"string" }, "pageViewType":{ "type":"string", "enum":[ "JSF", "JSPX" ] }, "created":{ "type":"string", "format":"date-time" }, "descriptionKey":{ "type":"string" }, "usesCustomSecurity":{ "type":"boolean" }, "iconURI":{ "type":"string" }, "displayName":{ "type":"string" }, "shortId":{ "type":"string" }, "securityId":{ "type":"string" }, "documentRef":{ "type":"string" }, "seeded":{ "type":"boolean" }, "id":{ "type":"string" }, "excludedFrom":{ "type":"string", "enum":[ "EXCLUDED_FROM_HOME_PORTAL", "EXCLUDED_FROM_ALL_PORTALS", "EXCLUDED_FROM_PORTAL_IDS" ] }, "panelFooterHeight":{ "type":"string" }, "templateFixedWidth":{ "type":"string" }, "wcsUsesSpacesNavigationPane":{ "type":"boolean" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "visible":{ "type":"boolean" }, "excludedPortalIds":{ "type":"string" }, "lockedBy":{ "type":"string" }, "modifier":{ "type":"string" }, "sidePanelWidth":{ "type":"string" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "pagePath":{ "type":"string" }, "sourcePath":{ "type":"string" }, "contentDir":{ "type":"string" }, "modified":{ "type":"string", "format":"date-time" }, "inputFileName":{ "type":"string" }, "sourcePageDefinitionPath":{ "type":"string" }, "pageDefinitionPath":{ "type":"string" }, "category":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "preferredSkin":{ "type":"string" }, "displayNameKey":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "logoURL":{ "type":"string" }, "description":{ "type":"string" }, "panelSeparatorWidth":{ "type":"string" }, "resourceBundle":{ "type":"string" }, "currentVersionId":{ "type":"string" } } }, "navigationnode":{ "properties":{ "showTagsAndLinks":{ "type":"string" }, "dataSourceType":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "advancedQueryOptions":{ "type":"string" }, "nextNode":{ "$ref":"#/definitions/Linked" }, "editDialogNeeded":{ "type":"string" }, "factoryClass":{ "type":"string" }, "uRL":{ "type":"string" }, "showLoginLink":{ "type":"string" }, "showRegisterLink":{ "type":"string" }, "persistURI":{ "type":"string" }, "iconURI":{ "type":"string" }, "redirect":{ "type":"string" }, "shortId":{ "type":"string" }, "displaySubPortalPages":{ "type":"string" }, "securityId":{ "type":"string" }, "pageTemplate":{ "type":"string" }, "documentRef":{ "type":"string" }, "id":{ "type":"string" }, "insertFolderContents":{ "type":"string" }, "parentNode":{ "$ref":"#/definitions/Linked" }, "creator":{ "type":"string" }, "portalPath":{ "type":"string" }, "name":{ "type":"string" }, "displayHelpInSecTabBar":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "accessKey":{ "type":"string" }, "pageHelpTopicId":{ "type":"string" }, "visible":{ "type":"string" }, "templateView":{ "type":"string" }, "modifier":{ "type":"string" }, "scope":{ "type":"string" }, "toolTip":{ "type":"string" }, "subject":{ "type":"string" }, "prepareTabs":{ "type":"string" }, "dataSource":{ "type":"string" }, "reference":{ "$ref":"#/definitions/reference" }, "title":{ "type":"string" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "pagePath":{ "type":"string" }, "deviceGroupFallback":{ "type":"string" }, "pageStyle":{ "type":"string" }, "itemType":{ "type":"string" }, "modified":{ "type":"string", "format":"date-time" }, "target":{ "type":"string" }, "previousNode":{ "$ref":"#/definitions/Linked" }, "pageVisibility":{ "type":"string" }, "excludedStyles":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "page":{ "$ref":"#/definitions/Linked" }, "externalId":{ "type":"string" }, "description":{ "type":"string" }, "currentVersionId":{ "type":"string" } } }, "visualizationtemplate":{ "properties":{ "translatedDescription":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "descriptionKey":{ "type":"string" }, "usesCustomSecurity":{ "type":"boolean" }, "iconURI":{ "type":"string" }, "displayName":{ "type":"string" }, "shortId":{ "type":"string" }, "securityId":{ "type":"string" }, "documentRef":{ "type":"string" }, "seeded":{ "type":"boolean" }, "id":{ "type":"string" }, "excludedFrom":{ "type":"string", "enum":[ "EXCLUDED_FROM_HOME_PORTAL", "EXCLUDED_FROM_ALL_PORTALS", "EXCLUDED_FROM_PORTAL_IDS" ] }, "pageDef":{ "type":"string" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "visible":{ "type":"boolean" }, "displayOptions":{ "type":"string" }, "excludedPortalIds":{ "type":"string" }, "lockedBy":{ "type":"string" }, "modifier":{ "type":"string" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "contentDir":{ "type":"string" }, "modified":{ "type":"string", "format":"date-time" }, "category":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "displayNameKey":{ "type":"string" }, "jspx":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "logoURL":{ "type":"string" }, "description":{ "type":"string" }, "resourceBundle":{ "type":"string" }, "currentVersionId":{ "type":"string" }, "metadataFile":{ "type":"string" } } }, "page":{ "properties":{ "deviceGroup":{ "type":"string" }, "pageViewType":{ "type":"string", "enum":[ "JSF", "JSPX" ] }, "created":{ "type":"string", "format":"date-time" }, "publishedDate":{ "type":"string", "format":"date-time" }, "shortId":{ "type":"string" }, "permissionClass":{ "type":"string" }, "securityId":{ "type":"string" }, "documentRef":{ "type":"string" }, "id":{ "type":"string" }, "pageStyleBean":{ "$ref":"#/definitions/Linked" }, "publishedBy":{ "type":"string" }, "creator":{ "type":"string" }, "name":{ "type":"string" }, "locale":{ "$ref":"#/definitions/Locale" }, "lockedBy":{ "type":"string" }, "modifier":{ "type":"string" }, "fileName":{ "type":"string" }, "keywords":{ "type":"string" }, "newVersionId":{ "type":"string" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "pagePath":{ "type":"string" }, "pageStyle":{ "type":"string" }, "sourcePath":{ "type":"string" }, "overridePolicy":{ "type":"boolean" }, "modified":{ "type":"string", "format":"date-time" }, "inputFileName":{ "type":"string" }, "sourcePageDefinitionPath":{ "type":"string" }, "pageDefinitionPath":{ "type":"string" }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "locked":{ "type":"boolean" }, "publishedVersion":{ "type":"integer", "format":"int32" }, "namespace":{ "type":"string" }, "resourceType":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "description":{ "type":"string" }, "currentVersionId":{ "type":"string" } } }, "portals":{ "properties":{ "itemsPerPage":{ "type":"integer", "format":"int32" }, "link":{ "type":"array", "items":{ "$ref":"#/definitions/link" } }, "linkStates":{ "type":"array", "items":{ "$ref":"#/definitions/LinkElementState" } }, "portal":{ "type":"array", "items":{ "$ref":"#/definitions/portal" } }, "resourceType":{ "type":"string" }, "startIndex":{ "type":"integer", "format":"int32" }, "totalResults":{ "type":"integer", "format":"int32" } } } }, "tags":[ { "name":"businessobjects", "description":"The operations from the businessobjects category." }, { "name":"cmis", "description":"The operations from the cmis category." }, { "name":"dptaskflows", "description":"The operations from the dptaskflows category." }, { "name":"layouts", "description":"The operations from the layouts category." }, { "name":"lists", "description":"The operations from the lists category." }, { "name":"navigationnodes", "description":"The operations from the navigationnodes category." }, { "name":"pages", "description":"The operations from the pages category." }, { "name":"pagestyles", "description":"The operations from the pagestyles category." }, { "name":"pagetemplates", "description":"The operations from the pagetemplates category." }, { "name":"portalTemplates", "description":"The operations from the portalTemplates category." }, { "name":"portals", "description":"The operations from the portals category." }, { "name":"preferences", "description":"The operations from the preferences category." }, { "name":"resourcecatalogs", "description":"The operations from the resourcecatalogs category." }, { "name":"restdataservices", "description":"The operations from the restdataservices category." }, { "name":"skins", "description":"The operations from the skins category." }, { "name":"sqldataservices", "description":"The operations from the sqldataservices category." }, { "name":"visualizationtemplates", "description":"The operations from the visualizationtemplates category." } ] }