123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!--
- Licensed Materials - Property of IBM
- IBM Cognos Products: cpscrn
- (C) Copyright IBM Corp. 2005, 2011
- US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
- -->
- <!--
- Copyright (C) 2008 Cognos ULC, an IBM Company. All rights reserved.
- Cognos (R) is a trademark of Cognos ULC, (formerly Cognos Incorporated).
- -->
- <!-- $Header: //cpscrn/main/templates/cps4/nav/schemas/inavigation.xsd#1 $ -->
- <!-- $DateTime: 2008/10/22 11:12:04 $ -->
- <!-- $Change: 25109 $ -->
- <xs:schema xmlns:nav="http://developer.cognos.com/schemas/cps/navigation/1/" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://developer.cognos.com/schemas/cps/navigation/1/" elementFormDefault="qualified" attributeFormDefault="unqualified">
- <!--
- Cognos Portal Services
- Navigation API 1.0
-
- Objects:
- container
- - - required (base) - -
- id
- parentId
- name
- fullName
- url
- - - optional (selectable via request property) (base) - -
- description?
- screenTip?
- createDate?
- lastModifiedDate?
- imgURL
- defaultAction
- action*
- - - container specific - -
- hasChildren?
- content
- @start
- @end
- @max
- @total
- @more
- (container | item | shortcut)*
-
- item
- id
- parentId
- name
- fullName
- - -
- description?
- screenTip?
- createDate?
- lastModifiedDate?
- imgURL
- defaultAction
- action*
- - - item specific - -
- newState
- readState
- viewable
-
- shortcut
- id
- parentId
- name
- fullName
- - -
- description?
- screenTip?
- createDate?
- lastModifiedDate?
- imgURL
- defaultAction
- action*
- - - referenced object - -
- container | item
- Operations:
- getContainer
- getItem
- search
- getItemType
- login
- -->
- <!--
- action Property
- -->
- <xs:complexType name="actionType">
- <xs:annotation>
- <xs:documentation>Describes an action associated with a specific object. It contains the calculated action url, icon and other related properties.</xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="redirectURL" type="xs:anyURI" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates that this action should use a redirect url</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="name" type="xs:string">
- <xs:annotation>
- <xs:documentation>Internal name of the action</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="alt" type="xs:string">
- <xs:annotation>
- <xs:documentation>Indicates the alternative text to use for the action link</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:choice>
- <xs:sequence>
- <xs:element name="url" type="nav:urlType">
- <xs:annotation>
- <xs:documentation>The action url</xs:documentation>
- </xs:annotation>
- </xs:element>
- </xs:sequence>
- <xs:sequence>
- <xs:element name="urlParts" type="nav:urlPartsType">
- <xs:annotation>
- <xs:documentation>The action url</xs:documentation>
- </xs:annotation>
- </xs:element>
- </xs:sequence>
- </xs:choice>
- <xs:element name="imgURL" type="xs:string">
- <xs:annotation>
- <xs:documentation>The icon url</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="usePost" type="xs:boolean" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates that this action should use a POST from when it's invoked.</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="windowProperties" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates that this action should open in a new window using the specified window properties.</xs:documentation>
- </xs:annotation>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- <!--
- icon Property
- -->
- <xs:complexType name="iconType">
- <xs:annotation>
- <xs:documentation>Describes an icon associated with a specific object (e.g. "disabled" icon)</xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="name" type="xs:string">
- <xs:annotation>
- <xs:documentation>Internal name of the icon</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="alt" type="xs:string">
- <xs:annotation>
- <xs:documentation>Indicates the alternative text to use for the action link</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="imgURL" type="xs:string">
- <xs:annotation>
- <xs:documentation>The icon url</xs:documentation>
- </xs:annotation>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- <!--
- sort type
- -->
- <xs:complexType name="sortType">
- <xs:annotation>
- <xs:documentation>Indicates the sort order and which property is used for sorting.</xs:documentation>
- </xs:annotation>
- <xs:simpleContent>
- <xs:extension base="xs:string">
- <xs:annotation>
- <xs:documentation>Possible values are "name", "lastModifiedDate" or 'displaySequence'</xs:documentation>
- </xs:annotation>
- <xs:attribute name="order" type="xs:string" use="required">
- <xs:annotation>
- <xs:documentation>Uses the values "ascending" or "descending"</xs:documentation>
- </xs:annotation>
- </xs:attribute>
- <xs:attribute name="usage" type="xs:string" use="optional">
- <xs:annotation>
- <xs:documentation>Uses the values "ascending" or "descending"</xs:documentation>
- </xs:annotation>
- </xs:attribute>
- </xs:extension>
- </xs:simpleContent>
- </xs:complexType>
- <!--
- requested property
- -->
- <xs:complexType name="requestedProperty">
- <xs:annotation>
- <xs:documentation>Indicates the properties to return in the response.</xs:documentation>
- </xs:annotation>
- <xs:simpleContent>
- <xs:extension base="xs:string">
- <xs:attribute name="name" type="xs:string" use="required">
- <xs:annotation>
- <xs:documentation>Name of the property. Possible values: "action", "actionsURL", "createDate", "internalId", "deploymentId", "description", "fullPath", "hasChildren", "icons", "lastModifiedDate", "newState", "parentId", "permissions", "readState", "screenTip", "searchPath", "status", "viewable", "containerLinks" will return the action links for the outer container, "searchTypes" to specifiy search sets for gettemTypes.</xs:documentation>
- </xs:annotation>
- </xs:attribute>
- </xs:extension>
- </xs:simpleContent>
- </xs:complexType>
- <!--
- global request param
- -->
- <xs:complexType name="globalRequestParam">
- <xs:annotation>
- <xs:documentation>A parameter used by NAV to render the response</xs:documentation>
- </xs:annotation>
- <xs:simpleContent>
- <xs:extension base="xs:string">
- <xs:attribute name="name" type="xs:string" use="required">
- <xs:annotation>
- <xs:documentation>Possible values: "gatewayURL", "webContentURL", "browserAgent"</xs:documentation>
- </xs:annotation>
- </xs:attribute>
- </xs:extension>
- </xs:simpleContent>
- </xs:complexType>
- <!--
- request param
- -->
- <xs:complexType name="requestParam">
- <xs:annotation>
- <xs:documentation>A parameter used by NAV to render the response</xs:documentation>
- </xs:annotation>
- <xs:simpleContent>
- <xs:extension base="xs:string">
- <xs:attribute name="name" type="xs:string" use="required">
- <xs:annotation>
- <xs:documentation>Possible values: "backUrl", "urlFlags", "useDefaultIcon", "defaultAction", "portalAgent", "gatewayURL", "webContentURL", "browserAgent", "cvId", "imageRoot" can be specified if you don't want the default '/ps/portal/images/' for example skin branding for getApplicationLinks, "actionsVisibilityLevel", "linksVisibilityLevel" for getContainer and getApplicationLinks,"verbose" for login</xs:documentation>
- </xs:annotation>
- </xs:attribute>
- </xs:extension>
- </xs:simpleContent>
- </xs:complexType>
- <!--
- fullPath Property
- -->
- <xs:complexType name="pathStepType">
- <xs:annotation>
- <xs:documentation>Indicates one step of the full path.</xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="id" type="xs:string">
- <xs:annotation>
- <xs:documentation>Identifier of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="name" type="xs:string">
- <xs:annotation>
- <xs:documentation>Name of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="pathStep" type="nav:pathStepType" minOccurs="0"/>
- </xs:sequence>
- </xs:complexType>
- <xs:complexType name="fullPathType">
- <xs:annotation>
- <xs:documentation>Describes the full path of an object.</xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="pathStep" type="nav:pathStepType" minOccurs="0"/>
- </xs:sequence>
- </xs:complexType>
- <!--
- Default URL Type
- -->
- <xs:complexType name="urlType">
- <xs:simpleContent>
- <xs:extension base="xs:string">
- <xs:attribute name="type" type="xs:string"/>
- </xs:extension>
- </xs:simpleContent>
- </xs:complexType>
- <xs:complexType name="urlPartsType">
- <xs:sequence>
- <xs:element name="gateway" type="xs:string">
- <xs:annotation>
- <xs:documentation>Gateway value</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="param" type="nav:urlParamType" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Url param</xs:documentation>
- </xs:annotation>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- <xs:complexType name="urlParamType">
- <xs:simpleContent>
- <xs:extension base="xs:string">
- <xs:attribute name="name" type="xs:string"/>
- </xs:extension>
- </xs:simpleContent>
- </xs:complexType>
- <!--
- Properties common to all objects
- -->
- <xs:group name="baseGroup">
- <xs:annotation>
- <xs:documentation>Properties common to all objects</xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="id" type="xs:string">
- <xs:annotation>
- <xs:documentation>Identifier of the object. This id is not deplayble</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="internalId" type="xs:string">
- <xs:annotation>
- <xs:documentation>Internal Identifier of the object. This id can be a CM id or series7 id</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="deploymentId" type="xs:string">
- <xs:annotation>
- <xs:documentation>Identifier of the object. This id can be deployed</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="parentId" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Identifier of the parent</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="name" type="xs:string">
- <xs:annotation>
- <xs:documentation>Name of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="type" type="xs:string">
- <xs:annotation>
- <xs:documentation>Type of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="fullName" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates the object name including the path. This property is only used in series7 NAV</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="description" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Description of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="screenTip" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Screentip of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="createDate" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Creation date of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="lastModifiedDate" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Modification date of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="fullPath" type="nav:fullPathType" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Full path of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="icon" type="nav:iconType" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Icon that is associated with the object (e.g "disabled" icon) </xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="imgURL" type="xs:string">
- <xs:annotation>
- <xs:documentation>Url of the icon associated with the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="defaultAction" type="nav:actionType" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Default action of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="action" type="nav:actionType" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Action that is associated with the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="searchPath" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Search path of the object</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="permissions" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Permissions of the object in string form</xs:documentation>
- </xs:annotation>
- </xs:element>
- <!-- optional (selectable via request property) (base) -->
- </xs:sequence>
- </xs:group>
- <xs:complexType name="extensionType">
- <xs:sequence>
- <xs:any namespace="##other"/>
- </xs:sequence>
- </xs:complexType>
- <!--
- container Object
- -->
- <xs:complexType name="contentType">
- <xs:annotation>
- <xs:documentation>Contains a list of objects. "container", "item" and "shortcut"</xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:choice minOccurs="0" maxOccurs="unbounded">
- <xs:element name="container" type="nav:containerType"/>
- <xs:element name="item" type="nav:itemType"/>
- <xs:element name="shortcut" type="nav:shortcutType"/>
- </xs:choice>
- <xs:element name="extensions" type="nav:extensionType" minOccurs="0" maxOccurs="unbounded"/>
- </xs:sequence>
- <xs:attribute name="start" type="xs:int" use="required">
- <xs:annotation>
- <xs:documentation>Pagination control, start index</xs:documentation>
- </xs:annotation>
- </xs:attribute>
- <xs:attribute name="end" type="xs:int" use="required">
- <xs:annotation>
- <xs:documentation>Pagination control, end index</xs:documentation>
- </xs:annotation>
- </xs:attribute>
- <xs:attribute name="max" type="xs:int" use="optional"/>
- <xs:attribute name="rangeIsApproximation" type="xs:boolean" use="optional"/>
- <xs:attribute name="total" type="xs:int" use="optional"/>
- <xs:attribute name="estimatedTotal" type="xs:int" use="optional"/>
- <xs:attribute name="more" type="xs:boolean" use="required">
- <xs:annotation>
- <xs:documentation>Pagination control, indicates that there are more items</xs:documentation>
- </xs:annotation>
- </xs:attribute>
- </xs:complexType>
- <xs:complexType name="containerType">
- <xs:sequence>
- <xs:group ref="nav:baseGroup"/>
- <xs:element name="hasChildren" type="xs:boolean" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates whether this container has children or not</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="content" type="nav:contentType" minOccurs="0">
- <xs:annotation>
- <xs:documentation>The content of this container</xs:documentation>
- </xs:annotation>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- <!--
- item Object
- -->
- <xs:complexType name="statusType">
- <xs:annotation>
- <xs:documentation>The status of an item. This is used by series7 NAV</xs:documentation>
- </xs:annotation>
- <xs:simpleContent>
- <xs:extension base="xs:string">
- <xs:attribute name="code" type="xs:string"/>
- </xs:extension>
- </xs:simpleContent>
- </xs:complexType>
- <xs:complexType name="itemType">
- <xs:sequence>
- <xs:group ref="nav:baseGroup"/>
- <xs:element name="newState" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates whether this is a new item or not. Used by the series7 NAV</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="readState" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates whether this is item is read or not. Used by the series7 NAV</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="status" type="nav:statusType" minOccurs="0"/>
- <xs:element name="viewable" type="xs:boolean" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates whether this item can be displayed in the Cognos viewer portlet</xs:documentation>
- </xs:annotation>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- <!--
- shortcut Object
- -->
- <xs:complexType name="shortcutType">
- <xs:sequence>
- <xs:group ref="nav:baseGroup"/>
- <xs:choice>
- <xs:annotation>
- <xs:documentation>Target object</xs:documentation>
- </xs:annotation>
- <xs:element name="container" type="nav:containerType"/>
- <xs:element name="item" type="nav:itemType"/>
- </xs:choice>
- </xs:sequence>
- </xs:complexType>
- <!--
- getContainer Operation
- -->
- <xs:simpleType name="childObjectsEnum">
- <xs:restriction base="xs:string">
- <xs:enumeration value="none"/>
- <xs:enumeration value="containers"/>
- <xs:enumeration value="items"/>
- <xs:enumeration value="all"/>
- </xs:restriction>
- </xs:simpleType>
- <xs:complexType name="getContainerRequestType">
- <xs:sequence>
- <xs:element name="validateTag" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Cache control</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="id" type="xs:string">
- <xs:annotation>
- <xs:documentation>identifier of the object, path:SearchPath where SearchPath is a CM search path or can also be one of these predefined ids: rootDefault, systemDefault or userDefault.</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="deploymentId" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>A deployable identifier</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:choice>
- <xs:element name="childObjects" type="nav:childObjectsEnum" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates the type of the requested objects</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="childObjectFilter" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Indicates the list of the requested objects</xs:documentation>
- </xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:element name="itemType" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:choice>
- <xs:element name="skipObjects" type="xs:int" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Pagination control. Indicates the number of objects to skip</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="maxObjects" type="xs:int" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Pagination control. Indicates the maximum number of objects to return</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="sort" type="nav:sortType" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Sort order</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="property" type="nav:requestedProperty" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Requested property</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="param" type="nav:requestParam" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Request parameter</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:complexType name="getContainerResponseType">
- <xs:sequence>
- <xs:element name="redirectURL" type="xs:anyURI" minOccurs="0">
- <xs:annotation>
- <xs:documentation>A global redirect url. If available, it should be used by all urls</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="container" type="nav:containerType"/>
- <xs:element name="validateTag" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Cache control</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:element name="getContainer" type="nav:getContainerRequestType"/>
- <xs:element name="getContainerResponse" type="nav:getContainerResponseType"/>
- <!--
- getItem Operation
- -->
- <xs:complexType name="getItemRequestType">
- <xs:sequence>
- <xs:element name="validateTag" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Cache control</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="id" type="xs:string">
- <xs:annotation>
- <xs:documentation>identifier of the object or path:SearchPath where SearchPath is a CM search path</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="deploymentId" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>A deployable identifier</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="property" type="nav:requestedProperty" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Requested property</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="param" type="nav:requestParam" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Request parameter</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:complexType name="getItemResponseType">
- <xs:sequence>
- <xs:element name="redirectURL" type="xs:anyURI" minOccurs="0">
- <xs:annotation>
- <xs:documentation>A global redirect url. If available, it should be used by all urls</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:choice>
- <xs:element name="container" type="nav:containerType"/>
- <xs:element name="item" type="nav:itemType"/>
- <xs:element name="shortcut" type="nav:shortcutType"/>
- </xs:choice>
- <xs:element name="validateTag" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Cache control</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="extensions" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:element name="getItem" type="nav:getItemRequestType"/>
- <xs:element name="getItemResponse" type="nav:getItemResponseType"/>
- <!--
- search Operation
- -->
- <!--
- icon Property
- -->
- <xs:complexType name="scopeInfoType">
- <xs:annotation>
- <xs:documentation>Information about the container specified as search scope</xs:documentation>
- </xs:annotation>
- <xs:sequence>
- <xs:element name="type" type="xs:string">
- <xs:annotation>
- <xs:documentation>Type of the container</xs:documentation>
- </xs:annotation>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- <xs:simpleType name="searchTypeEnum">
- <xs:restriction base="xs:string">
- <xs:enumeration value="normal"/>
- <xs:enumeration value="content"/>
- </xs:restriction>
- </xs:simpleType>
- <xs:simpleType name="searchObjectsEnum">
- <xs:restriction base="xs:string">
- <xs:enumeration value="containers"/>
- <xs:enumeration value="items"/>
- <xs:enumeration value="all"/>
- </xs:restriction>
- </xs:simpleType>
- <xs:simpleType name="searchMatchEnum">
- <xs:restriction base="xs:string">
- <xs:enumeration value="all">
- <xs:annotation>
- <xs:documentation>matches all the words (AND)</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="any">
- <xs:annotation>
- <xs:documentation>matches any of the words (OR)</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="exact">
- <xs:annotation>
- <xs:documentation>matches the exact phrase</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="contains">
- <xs:annotation>
- <xs:documentation>matches the exact phrase, partially</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="starts">
- <xs:annotation>
- <xs:documentation>matches the exact phrase, only if starts with the search phrase</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- </xs:restriction>
- </xs:simpleType>
- <xs:simpleType name="searchFieldsEnum">
- <xs:restriction base="xs:string">
- <xs:enumeration value="ndf">
- <xs:annotation>
- <xs:documentation>name or description fields</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="nf">
- <xs:annotation>
- <xs:documentation>name field only (default)</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="df">
- <xs:annotation>
- <xs:documentation>description field only</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="cf">
- <xs:annotation>
- <xs:documentation>contact field only</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- </xs:restriction>
- </xs:simpleType>
- <xs:simpleType name="searchStateEnum">
- <xs:restriction base="xs:string">
- <xs:enumeration value="any"/>
- <xs:enumeration value="unread"/>
- <xs:enumeration value="read"/>
- <xs:enumeration value="new"/>
- </xs:restriction>
- </xs:simpleType>
- <xs:complexType name="itemTypes">
- <xs:sequence>
- <xs:element name="itemType" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
- </xs:sequence>
- </xs:complexType>
- <xs:complexType name="searchRequestType">
- <xs:sequence>
- <xs:element name="validateTag" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Cache control</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="string" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Search string.
- **
- MANDATORY FOR NON Cognos GO! Searches
- **</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="skipObjects" type="xs:int">
- <xs:annotation>
- <xs:documentation>Pagination control. Indicates the number of objects to skip</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="maxObjects" type="xs:int">
- <xs:annotation>
- <xs:documentation>Pagination control. Indicates the maximum number of objects to return</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="context" type="xs:base64Binary" minOccurs="0">
- <xs:annotation>
- <xs:documentation>A search context. Returned by a previous searcg request.
- **
- MANDATORY FOR Cognos GO! Searches
- **</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="searchType" type="nav:searchTypeEnum" default="normal" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Type of objects to search for
- ***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="objects" type="nav:searchObjectsEnum" default="all" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Type of objects to search for
- ***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="match" type="nav:searchMatchEnum" default="all" minOccurs="0">
- <xs:annotation>
- <xs:documentation>***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="fields" type="nav:searchFieldsEnum" default="nf" minOccurs="0">
- <xs:annotation>
- <xs:documentation>***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="itemType" type="xs:string" default="any" minOccurs="0">
- <xs:annotation>
- <xs:documentation>***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="itemTypes" type="nav:itemTypes" minOccurs="0">
- <xs:annotation>
- <xs:documentation>***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="itemState" type="nav:searchStateEnum" default="any" minOccurs="0">
- <xs:annotation>
- <xs:documentation>***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="itemModified" type="xs:string" default="any" minOccurs="0">
- <xs:annotation>
- <xs:documentation>***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="scope" type="xs:string" default="systemDefault" minOccurs="0">
- <xs:annotation>
- <xs:documentation>To limit the search to the public folders use (systemDefault).
- To limit the search to the my folders use (userDefault).
- Otherwise the string represents a path.
- ***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="recursive" type="xs:boolean" default="true" minOccurs="0">
- <xs:annotation>
- <xs:documentation>***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="sort" type="nav:sortType" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Sort order
- ***
- N/A FOR Cognos GO! Searches
- ***</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="property" type="nav:requestedProperty" minOccurs="0" maxOccurs="unbounded"/>
- <xs:element name="param" type="nav:requestParam" minOccurs="0" maxOccurs="unbounded"/>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:complexType name="searchResponseType">
- <xs:sequence>
- <xs:element name="redirectURL" type="xs:anyURI" minOccurs="0"/>
- <xs:element name="scopeInfo" type="nav:scopeInfoType" minOccurs="0"/>
- <xs:element name="context" type="xs:base64Binary" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Search context to be used in subsequent searches</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="content" type="nav:contentType"/>
- <xs:element name="validateTag" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Cache control</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="extenstion" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:element name="search" type="nav:searchRequestType"/>
- <xs:element name="searchResponse" type="nav:searchResponseType"/>
- <!--
- getItemTypes Operation
- -->
- <xs:complexType name="itemTypesType">
- <xs:sequence>
- <xs:element name="id" type="xs:string"/>
- <xs:element name="description" type="xs:string"/>
- </xs:sequence>
- </xs:complexType>
- <xs:complexType name="itemListType">
- <xs:sequence>
- <xs:element name="itemType" type="nav:itemTypesType" minOccurs="0" maxOccurs="unbounded"/>
- </xs:sequence>
- <xs:attribute name="type" type="xs:string" use="required"/>
- </xs:complexType>
- <xs:complexType name="getItemTypesResponseType">
- <xs:sequence>
- <xs:element name="items" type="nav:itemListType" minOccurs="0" maxOccurs="unbounded"/>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:element name="getItemTypes" type="nav:getItemTypesType"/>
- <xs:element name="getItemTypesResponse" type="nav:getItemTypesResponseType"/>
- <!--
- login Operation
- -->
- <xs:complexType name="credentialType">
- <xs:simpleContent>
- <xs:extension base="xs:string">
- <xs:attribute name="name" type="xs:string"/>
- <xs:attribute name="path" type="xs:string" use="optional"/>
- <xs:attribute name="domain" type="xs:string" use="optional"/>
- <xs:attribute name="maxAge" type="xs:int" use="optional"/>
- </xs:extension>
- </xs:simpleContent>
- </xs:complexType>
- <xs:simpleType name="authenticationMethodEnum">
- <xs:restriction base="xs:string">
- <xs:enumeration value="logon">
- <xs:annotation>
- <xs:documentation>Uses namespace, username and password to perform the logon.</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="sso">
- <xs:annotation>
- <xs:documentation>Uses the ossignon (user account) and a namespace id.</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="anonymous">
- <xs:annotation>
- <xs:documentation>Anonymous authentication (namespace, username and password are not used at all)</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- <xs:enumeration value="guest">
- <xs:annotation>
- <xs:documentation>Uses the guest account to authenticate the user.</xs:documentation>
- </xs:annotation>
- </xs:enumeration>
- </xs:restriction>
- </xs:simpleType>
- <xs:element name="login" type="nav:loginType"/>
- <xs:element name="loginResponse" type="nav:loginResponseType"/>
- <!--
- getServiceDescription
- -->
- <xs:complexType name="getServiceDescriptionResponseType">
- <xs:sequence>
- <xs:element name="platform" type="xs:string"/>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:element name="getServiceDescription" type="nav:getServiceDescriptionType"/>
- <xs:element name="getServiceDescriptionResponse" type="nav:getServiceDescriptionResponseType"/>
- <xs:complexType name="requestType">
- <xs:sequence>
- <xs:element name="validateTag" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Cache control</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="param" type="nav:globalRequestParam" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Golbal request parameter: gatewayURL, webContentURL, browserAgent. Since these are global, they are not supported on individual query.</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="queries">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="query" maxOccurs="unbounded">
- <xs:complexType>
- <xs:choice>
- <xs:element ref="nav:getContainer"/>
- <xs:element ref="nav:getItem"/>
- <xs:element ref="nav:getItemTypes"/>
- <xs:element ref="nav:getServiceDescription"/>
- <xs:element ref="nav:login"/>
- <xs:element ref="nav:search"/>
- </xs:choice>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:complexType name="responseType">
- <xs:sequence>
- <xs:element name="queryReplies">
- <xs:annotation>
- <xs:documentation>queryReply holder</xs:documentation>
- </xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:element name="queryReply" maxOccurs="unbounded">
- <xs:complexType>
- <xs:choice>
- <xs:element ref="nav:getContainerResponse"/>
- <xs:element ref="nav:getItemResponse"/>
- <xs:element ref="nav:getItemTypesResponse"/>
- <xs:element ref="nav:getServiceDescriptionResponse"/>
- <xs:element ref="nav:loginResponse"/>
- <xs:element ref="nav:searchResponse"/>
- </xs:choice>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- <xs:element name="validateTag" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>Cache control</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:element name="request" type="nav:requestType"/>
- <xs:element name="requestResponse" type="nav:responseType"/>
- <xs:complexType name="getServiceDescriptionType">
- <xs:sequence>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:complexType name="getItemTypesType">
- <xs:sequence>
- <xs:element name="property" type="nav:requestedProperty" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Requested property: only "searchTypes" applies.</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:complexType name="loginType">
- <xs:sequence>
- <xs:element name="method" type="nav:authenticationMethodEnum" minOccurs="0"/>
- <xs:element name="username" type="xs:string" minOccurs="0"/>
- <xs:element name="password" type="xs:string" minOccurs="0"/>
- <xs:element name="namespace" type="xs:string" minOccurs="0">
- <xs:annotation>
- <xs:documentation>the namespace id (if blank, use default namespace)</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="role" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
- <xs:element name="param" type="nav:requestParam" minOccurs="0" maxOccurs="unbounded">
- <xs:annotation>
- <xs:documentation>Request parameter: "verbose" and "userName" apply.</xs:documentation>
- </xs:annotation>
- </xs:element>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:complexType name="loginResponseType">
- <xs:sequence>
- <xs:element name="credential" type="nav:credentialType" minOccurs="0" maxOccurs="unbounded"/>
- <xs:element name="extension" type="nav:extensionType" minOccurs="0"/>
- </xs:sequence>
- <xs:anyAttribute namespace="##any" processContents="lax"/>
- </xs:complexType>
- <xs:complexType name="Fault">
- <xs:sequence/>
- </xs:complexType>
- <xs:complexType name="OperationFailedFault">
- <xs:complexContent>
- <xs:extension base="nav:Fault">
- <xs:sequence/>
- </xs:extension>
- </xs:complexContent>
- </xs:complexType>
- <xs:element name="OperationFailed" type="nav:OperationFailedFault"/>
- <xs:complexType name="InvalidCredentialsFault">
- <xs:complexContent>
- <xs:extension base="nav:Fault">
- <xs:sequence/>
- </xs:extension>
- </xs:complexContent>
- </xs:complexType>
- <xs:element name="InvalidCredentials" type="nav:InvalidCredentialsFault"/>
- </xs:schema>
|