Fundamentals - Web Services

Transcription

1 Fundamentals - Web Services Avaya MS 7.0 NN , Dec 2010

2 2010 Avaya Inc. All Rights Reserved. Notice While reasonable efforts have been made to ensure that the information in this document is complete and accurate at the time of printing, Avaya assumes no liability for any errors. Avaya reserves the right to make changes and corrections to the information in this document without the obligation to notify any person or organization of such changes. Documentation disclaimer Documentation means information published by Avaya in varying mediums which may include product information, operating instructions and performance specifications that Avaya generally makes available to users of its products. Documentation does not include marketing materials. Avaya shall not be responsible for any modifications, additions, or deletions to the original published version of documentation unless such modifications, additions, or deletions were performed by Avaya. End User agrees to indemnify and hold harmless Avaya, Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation, to the extent made by End User. Link disclaimer Avaya is not responsible for the contents or reliability of any linked Web sites referenced within this site or documentation provided by Avaya. Avaya is not responsible for the accuracy of any information, statement or content provided on these sites and does not necessarily endorse the products, services, or information described or offered within them. Avaya does not guarantee that these links will work all the time and has no control over the availability of the linked pages. Warranty Avaya provides a limited warranty on its Hardware and Software ( Product(s) ). Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avaya s standard warranty language, as well as information regarding support for this Product while under warranty is available to Avaya customers and other parties through the Avaya Support Web site: Please note that if you acquired the Product(s) from an authorized Avaya reseller outside of the United States and Canada, the warranty is provided to you by said Avaya reseller and not by Avaya. Licenses THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA WEBSITE, ARE APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC., ANY AVAYA AFFILIATE, OR AN AUTHORIZED AVAYA RESELLER (AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH AVAYA OR AN AUTHORIZED AVAYA RESELLER. UNLESS OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED FROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE OR AN AVAYA AUTHORIZED RESELLER; AVAYA RESERVES THE RIGHT TO TAKE LEGAL ACTION AGAINST YOU AND ANYONE ELSE USING OR SELLING THE SOFTWARE WITHOUT A LICENSE. BY INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING, DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER REFERRED TO INTERCHANGEABLY AS YOU AND END USER ), AGREE TO THESE TERMS AND CONDITIONS AND CREATE A BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE APPLICABLE AVAYA AFFILIATE ( AVAYA ). Copyright Except where expressly stated otherwise, no use should be made of materials on this site, the Documentation, Software, or Hardware provided by Avaya. All content on this site, the documentation and the Product provided by Avaya including the selection, arrangement and design of the content is owned either by Avaya or its licensors and is protected by copyright and other intellectual property laws including the sui generis rights relating to the protection of databases. You may not modify, copy, reproduce, republish, upload, post, transmit or distribute in any way any content, in whole or in part, including any code and software unless expressly authorized by Avaya. Unauthorized reproduction, transmission, dissemination, storage, and or use without the express written consent of Avaya can be a criminal, as well as a civil offense under the applicable law. Third-party components Certain software programs or portions thereof included in the Product may contain software distributed under third party agreements ( Third Party Components ), which may contain terms that expand or limit rights to use certain portions of the Product ( Third Party Terms ). Information regarding distributed Linux OS source code (for those Products that have distributed the Linux OS source code), and identifying the copyright holders of the Third Party Components and the Third Party Terms that apply to them is available on the Avaya Support Web site: Trademarks The trademarks, logos and service marks ( Marks ) displayed in this site, the Documentation and Product(s) provided by Avaya are the registered or unregistered Marks of Avaya, its affiliates, or other third parties. Users are not permitted to use such Marks without prior written consent from Avaya or such third party which may own the Mark. Nothing contained in this site, the Documentation and Product(s) should be construed as granting, by implication, estoppel, or otherwise, any license or right in and to the Marks without the express written permission of Avaya or the applicable third party. Avaya is a registered trademark of Avaya Inc. All non-avaya trademarks are the property of their respective owners, and Linux is a registered trademark of Linus Torvalds. Downloading Documentation For the most current versions of Documentation, see the Avaya Support Web site: Contact Avaya Support Avaya provides a telephone number for you to use to report problems or to ask questions about your Product. The support telephone number is in the United States. For additional support telephone numbers, see the Avaya Web site: 2 Fundamentals - Web Services 3 Dec 2010

3 Contents Chapter 1: New in this release...5 Features...5 Other changes...5 Chapter 2: Introduction...7 Chapter 3: Content Store Web Service...9 Overview...9 Architecture...10 Storage...11 CStore characteristics...12 File name requirements...12 Stored files...13 Internal audits...13 Content marked as deleted...14 Content expiry...14 Global storage space audit...14 Content Group real-time access and mirroring...14 Validating addresses...15 Parameter validation...15 WSDL...15 WSDL location...16 Service endpoint...17 AdministrativeCommand operation...17 Request...17 Response...19 AdministrativeCommand examples...19 CreateNamespace example...19 GetNamespaces example...20 CreateContentGroup example...21 CopyContentGroup example...21 QueryNamespaceSize example...22 IngestContent operation...23 Request...23 Response...25 IngestContent examples...25 IngestContent example with Content ID specified...25 IngestContent example with reingest...26 IngestContent example with no Content ID specified...27 FetchContent operation...27 Request...28 Response...28 FetchContent example...28 SearchContent operation...29 Request...29 Response...31 SearchContent example...31 ModifyXMLContent operation...32 Fundamentals - Web Services 3 Dec

4 Request...32 ModifyXMLContent example...33 QueryXMLContent operation...34 Request...34 Response...34 QueryXMLContent example...34 SearchXMLContent operation...35 Request...36 Response...37 SearchXMLContent example...38 ModifyContentMetaData operation...38 Request...38 ModifyContentMetaData example...39 QueryContentMetaData operation...40 Request...40 Response...41 QueryContentMetaData example...41 DeliverContent operation...42 Request...42 DeliverContent example...44 Chapter 4: Application Web Service...45 Overview...45 WSDL...45 WSDL location...46 Service endpoint...46 InvokeApplication operation...46 Request...46 Response...47 InjectApplicationSessionEvent operation...48 Request...48 Response...48 ListApplicationSessions operation...49 Request...49 Response...49 QueryApplicationSession operation...51 Request...51 Response...51 QueryApplicationSessionStatus operation...53 Request...53 Response...54 QueryActiveSDRs operation...54 Request...54 Response Fundamentals - Web Services 3 Dec 2010

5 Chapter 1: New in this release The following sections detail what is new in Avaya Media Server Fundamentals - Web Services, NN Features on page 5 Other changes on page 5 Features This document is new for Avaya Media Server Release 7.0. Other changes There are no other changes to this document. Fundamentals - Web Services 3 Dec

6 New in this release 6 Fundamentals - Web Services 3 Dec 2010

7 Chapter 2: Introduction This document provides information about the Web Services available on the Avaya Media Server. Navigation Content Store Web Service on page 9 Application Web Service on page 45 Fundamentals - Web Services 3 Dec

8 Introduction 8 Fundamentals - Web Services 3 Dec 2010

9 Chapter 3: Content Store Web Service This section describes the Content Store Web Service component of the Avaya Media Server. Navigation Overview on page 9 Architecture on page 10 WSDL on page 15 Overview The Content Store (CStore) is a component on the Avaya MS that provides reliable, highly available persistent mass storage capability. The CStore can be used by any application client that has storage requirements that align with the functionality provided by the Content Store. Various types of data and files can be stored on the Content Store for application use. A data record is stored for each file on the CStore that contains various system and meta data fields. Also, flat XML files can be saved, modified, and queried to provide unlimited data storage options for clients. For example, XML files could contain user preferences or subscriber data which does not fit as meta data in the fixed record. The CStore maintains a strictly generic view of all data and supports a simple request and response type interface. All application functionality related to the content is implemented by the clients using the Web services. The following table identifies the CStore services available. Table 1: CStore services Operation AdministrativeCommand IngestContent FetchContent SearchContent QueryContentMetaData ModifyContentMetaData ModifyXMLConent Description Storage space setup and maintenance. Content is saved in storage using the instructed file pull. Retrieves previously ingested content. Find content matching the specified criteria. Get all available detailed attributes for specified content. Alter the content attributes. Alter XML based content. Fundamentals - Web Services 3 Dec

10 Content Store Web Service Operation QueryXMLConetent SearchXMLContent DeliverContent Description Get the current value of XML based content. Search the content of ingested XML files. Compose an and send content to an user. A Content Store ingests or pulls content for storage on to its disks as indicated by URLs provided by clients. The ingested content is stored in Content Groups that are organized under Namespaces. Ingested files are considered opaque to the CStore and are generically handled and catalogued by the CStore. Only clients can add and delete content and the clients are solely responsible for content management. The Content Store stores content and makes saved content accessible to the entire cluster. In response to IngestContent or as a result of a QueryContentMetaData, the requestor is provided access to the content by way of a URL which physically resolves back to the storage array of the Content Store. URLs returned indicate the file transfer mechanism as either file:// (for fast same machine, local access) or rtft:// (for local or remote access to the Content Store file system. The content can be accessed only by these URLs, the file system cannot be accessed directly. To support capacity or high availability requirements of some installations, the Content Store is scaled automatically in a cluster by adding up to two additional servers, one on each the Primary and Secondary cluster servers. This provides full hardware redundancy for critical applications. These Content Stores communicate with each other to service requests without the requestors knowledge. A connection to any one Content Store in a cluster is sufficient for any client. All synchronization between the Content Stores in a cluster is handled automatically behind the client API. Architecture This section provides details about the Content Store. Architecture navigation Storage on page 11 CStore characteristics on page 12 File name requirements on page 12 Stored files on page 13 Internal audits on page 13 Content Group real-time access and mirroring on page Fundamentals - Web Services 3 Dec 2010

11 Storage Validating addresses on page 15 Parameter validation on page 15 Storage Content Stores are configured with an organized storage space that contains storage roots that have Namespaces with Content Groups and the actual content. The Namespace is the top level container. Content Group containers exist under Namespaces. Actual content is stored by Content ID in each Content Group. For example: Namespace_I ContentGroup_A Content ID1 Content ID2 ContentGroup_B Content ID1 Content ID2 Namespace_II ContentGroup_A Content ID1 Content ID2 Namespaces and Content Groups are like folders. The Content Store only has these levels but Element Manager (EM) is set up to simulate more levels by using forward slashes (/) in the Content Group names. Any application or tool can simulate logical subgroups. Using a forward slash for logical sub groups, however, is compatible with using the Media Management tool in EM. Without a logical Content Group hierarchy, a Namespace has one level of Content Groups under it. For example: Avaya Music With logical Content Group hierarchy the storage looks like the following: Avaya Music Music/rock Music/rock/80s Music/rock/90s Music/country Music/classical Music/classical/bach Music/classical/handel Applications logically interpret this hierarchy as follows: Avaya Music rock rock 80s 90s country classical bach handel Music/rock/80s is a unique Content Group in the Content Store, but can be parsed by the application by using the forward slash, or any other character, to have additional organization. In Element Manager, navigate to Tools > MediaManagement to perform simple content management and provisioning orto explore existing Content Store data. Fundamentals - Web Services 3 Dec

12 Content Store Web Service CStore characteristics Content Stores have the following characteristics: Namespaces must be unique. Content Group names must be unique within a Namespace. System assigned or client provided Content ID names need only be unique within a Content Group. All Namespace directories and Content files are given unique system generated names when they are stored on disk and is managed by the Content Store. Clients are not aware of the actual file names except in the URLs used for accessing content. A data record is stored for each file on the Content Store. Various system and meta data fields are in this fixed record. Any data marked as Opague is information that is provided and manipulated only by the client and blindy stored and retrieved by the Content Store on behalf of the client. Flat XML files can be saved, modified, and queried to provide unlimited data storage options for clients. For example, XML files can contain user preferences or subscriber data that does not fit as meta data in the fixed record. The XML root must be <XML>...</ XML> and only one level of tags is allowed. The tags must not exceed 64 characters. Many other file types can be generically stored in the Content Store and retrieved by an application. The Content Store cannot look into the contents of any file other than.xml files A backup and restore tool is providedusing the management console that zips up the content, and optionallytransfers the file using FTP. Local disk space must be available tocreate or restore the backup file. The Content Store is scaled automatically with the cluster by adding up to two additional content stores (one on each the Primary and Secondary cluster servers). Content Stores communicate with each other in to service requests they receive with out the requestors knowledge. A connection to any one Content Store in a cluster is sufficient for any client. Synchronization between the Content Stores in a cluster is handled automatically behind the client API. File name requirements Namespaces and Content Groups have the following naming requirements: Names are not case sensitive. Cannot begin with the at (@) symbol. 12 Fundamentals - Web Services 3 Dec 2010

13 Stored files Must not contain the following characters: { } ' or \. Must be less than 128 characters. Must not contain spaces. Content IDs have the following naming requirements: Names are not case sensitive. Must not contain the following characters: { } ' or \. Must be less than 128 characters. If a Content ID is not provided, one is generated. All other characters are acceptable. The Content Store validates the names in the requests and creates its own folders and ID names using unique numbers for actual disk storage, all hidden from the users and apps. Navigating the file system to try to find these files is not recommended. Stored files Clients must reference content by the Content ID or the URL provided, never by the file system directly. To retrieve content, you can perform a QueryContentMetaData to get the URL of the file associated with a specific Content ID. The file specified in the URL can change even while the Content ID is the same. The client application must not cache the URL, the application must get the latest URL from a QueryContentMetaData request. When a client ingests new content (updates a file), the Content ID stays the same, but the system assigned file name changes and the old file is queued for deletion. This happens because the old file may be in use (for example, an audio file being played), but the system must still be able to ingest the new content. The old file is left for the current user (playing the file) and the new file is created while the database is updated to reference the new ingested file. Internal audits This section provides information about internal audits on the Content Store. Internal audits navigation Content marked as deleted on page 14 Content expiry on page 14 Global storage space audit on page 14 Fundamentals - Web Services 3 Dec

14 Content Store Web Service Content marked as deleted Content Stores periodically audit for content marked as deleted by clients. Real time requests from the applications often result in the content being marked for deletion to avoid file contention issues and to allow rapid response times on the API. Actual removal occurs when the audit runs for a periodic garbage collection. Content delete flags may need to be checked by the applications. Deleting files is also delayed so that applications or users can undelete a file (as long as the file is undeleted before the audit runs). There is also an option for immediate content item deletes. Refer to the services descriptions to see how to control this. After each garbage collection completes, the free disk space is determined. An alarm is raised if the free space threshold is exceeded. Content expiry Clients can provide an expiration date or time for any stored data. An audit deletes all expired content. The exact expiration time depends on the configured audit frequency. Global storage space audit Content Stores periodically audit the entire content it manages. Any necessary garbage collection is performed, and files unrelated to the current managed content are removed from the configured storage roots. The StorageRoot is a restricted Content Store managed area. Content Group real-time access and mirroring Access to a Content Group is serialized because the data integrity protection mechanism is employed. This ensures that requests for a particular Content Group are processed in the order received, while preventing simultaneous reads or writes on one server and simultaneous writes in clusters. However, by using multiple threads, many different Content Groups can be processed simultaneously. In a clustered Avaya MS system with mirrored Content Stores, a write token is required before any content is committed to a Content Store. A token is granted to a requesting peer Content Store as soon a local use of the token is completed. The content is then mirrored to the other Content Stores. Reads do not require token permission from the peer Content Store and reads 14 Fundamentals - Web Services 3 Dec 2010

15 Validating addresses can occur simultaneously for the same Content Group on different Content Stores of the platform. When either the primary or secondary CStore are out of service or disconnected from the peer, certain behaviors change due to the current implementation. Namespaces and Content Groups cannot be deleted while the connection to the peer is down. Errors occur if a delete request is made during this state. Adding or modifying content is permitted and data is synced when the peers regain their connection to each other. Validating addresses The Avaya MS does not validate addresses. Any addresses received in client API requests can be rejected by the SMTP mail server with out notice to the client. Initial validation of Avaya MS parameters and the responses are synchronous, but not inclusive of the SMTP server requests and corresponding responses. It is expected addresses received are valid as provisioned on the customer system. Parameter validation Mandatory, conditional, and optional parameters in various combinations provide input for the requested functionality. You must include or exclude the parameters to obtain the desired functionality in the WSDL descriptions. In cases where an operation is given and the desired functionality is obvious, any extraneous parameters are ignored and the request is processed. If the extra parameter implies an attempt at different functionality, or it could cause negative system impact, then an error is returned to the client. Parameters defined as integers must contain an integer number. There is some tolerance for the data provided for integer parameters. They must start with a digit 0 to 9, but any characters after the initial integer are ignored. For example, 123abc is accepted as 123 and hello123abc is rejected because it does not start with a number. Any parameters related to naming objects, are subject to errors based on the naming rules. WSDL This section provides information about the Web Service description language (WSDL) for the Content Store Web Service. All Content Store services are in request and response pairs. Parameters are either mandatory, optional, or conditional (that is, mandatory in certain contexts). The following table identifies the Content Store services. Fundamentals - Web Services 3 Dec

16 Content Store Web Service Table 2: CStore services Operation AdministrativeCommand IngestContent FetchContent SearchContent QueryContentMetaData ModifyContentMetaData ModifyXMLConent QueryXMLConetent SearchXMLContent DeliverContent Description Storage space setup and maintenance. Content is saved in storage using the instructed file pull. Retrieves previously ingested content. Find content matching the specified criteria. Get all available detailed attributes for specified content. Alter the content attributes. Alter XML based content. Get the current value of XML based content. Search the content of ingested XML files. Compose an and send content to an user. Navigation WSDL location on page 16 Service endpoint on page 17 AdministrativeCommand operation on page 17 IngestContent operation on page 23 FetchContent operation on page 27 SearchContent operation on page 29 ModifyXMLContent operation on page 32 QueryXMLContent operation on page 34 SearchXMLContent operation on page 35 ModifyContentMetaData operation on page 38 QueryContentMetaData operation on page 40 DeliverContent operation on page 42 WSDL location The Content Store Web Service WSDL is available at the following URL: 16 Fundamentals - Web Services 3 Dec 2010

17 Service endpoint Service endpoint The Content Store Web Service WSDL endpoint is: AdministrativeCommand operation The AdministrativeCommand performs a variety of administrative operations on Cstore. Request The AdministrativeCommand request provides administrative services for the Content Store storage space for provisioning and general management. Operations include creating Namespaces and Content Groups, deleting Namespaces and Content Groups, and querying both Content Group and Namespace sizes. The following table provides information about the AdministrativeCommand request parameters. Table 3: AdministrativeCommand request parameters Parameter Requirement s Namespace Conditional Namespace. ContentGroup Conditional Content Group. Description ContentID Conditional Required for ContentID operations. Operation Mandatory The operation to perform. See Operation. NewName Conditional Specifies the new name to be used for a rename operation. CopyToNamespace Conditional Specifies the target Namespace to copy. CopyToContentGroup Conditional Specifies the target ContentGroup to copy. Gslid Optional Global Session Log Identifier for tracing a transaction The following table lists the values and services for the Operation parameter. Parameters other than the required parameters are ignored. However, if the ContentGroup parameter is specified Fundamentals - Web Services 3 Dec

18 Content Store Web Service in a Namespace only operation (like QueryNamespacePresence), an error occurs and the ContentGroup parameter must be removed to process the request. Table 4: AdministrativeCommand Operation parameter details Operation Description Required Parameters CreateNamespace CreateContentGroup QueryNamespacePresence QueryContentGroupPresenc e QueryNamespaceSize QueryContentGroupSize CopyContent CopyContentGroup DeleteNamespace DeleteContentGroup GetNamespaces GetContentGroups Create a new Namespace with the name provided. Create a new content group with the name provided in the specified Namespace. Determines if a Namespace exists. The result parameters are: 1 found 0 not found Determines if a content group exists. The result parameters are: 1 found 0 not found Calculate and return the size of the all the mailboxes in the specified Namespace. Calculate and return the size of the specified Content Group. Copies one content item from one Namespace or mailbox to the specified Namespace or mailbox. Copies an entire Content Group and its content to the specified Namespace or Content Group. Delete the specified Namespace. Delete the specified Content Group from the specified Namespace. Returns an list of all the Namespaces on the Content Store. Returns a list of all the Content Groups in the specified Namespace. Operation Namespace Operation Namespace ContentGroup Operation Namespace Operation Namespace ContentGroup Operation Namespace Operation Namespace ContentGroup Operation Namespace ContentGroup CopyToNamespace CopyToContentGroup ContentID NewName Operation Namespace ContentGroup CopyToNamespace CopyToContentGroup Operation Namespace Operation Namespace ContentGroup Operation Operation Namespace 18 Fundamentals - Web Services 3 Dec 2010

19 Response Operation Description Required Parameters RenameContentGroup Rename an existing Content Group. Operation Namespace ContentGroup NewName RenameContentID Rename a Content Group ID. Operation Namespace ContentGroup ContentID NewName RenameNamespace Rename an existing Namespace. Operation Namespace NewName Response The following table provides information about the AdministrativeCommand response parameters. Note that the Result and AdministrativeQueryItem parameters are mutually exclusive and conditional on the request; they are never both returned in the same response. Table 5: AdministrativeCommand response parameters Parameter Requirements Description Result Conditional The result of the command. AdministrativeQueryItem Conditional A list of one or more items of information answering the query command. AdministrativeCommand examples The following are examples of the AdministrativeCommand. AdministrativeCommand is typically used by clients performing management and provisioning tasks for applications hosed on the Avaya MS. CreateNamespace example <soapenv:envelope xmlns:soapenv=" envelope/" xmlns:v1=" content_store/v1_0/"> <soapenv:header/> <soapenv:body> <v1:administrativecommand> <Operation> CreateNamespace </Operation> Fundamentals - Web Services 3 Dec

20 Content Store Web Service <NameSpace> Avaya </NameSpace> </v1:administrativecommand> </ soapenv:body> </soapenv:envelope> <SOAP-ENV:Envelope xmlns:soap-enc=" encoding/" xmlns:soap-env=" envelope/" xmlns:ns1="urn:masservice" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" applications/invoke/v1_0/" xmlns:ns5="urn:maswsutilityapi" xmlns:xsd=" xmlns:xsi=" <SOAP-ENV:Header/> <SOAP- ENV:Body> <ns3:administrativecommandresponse/> </SOAP-ENV:Body> </ SOAP-ENV:Envelope> GetNamespaces example <soapenv:envelope xmlns:soapenv=" envelope/" xmlns:v1=" content_store/v1_0/"> <soapenv:header/> <soapenv:body> <v1:administrativecommand> <Operation> GetNamespaces </Operation> </v1:administrativecommand> </soapenv:body> </soapenv:envelope> <SOAP-ENV:Envelope xmlns:soap-enc=" encoding/" xmlns:soap-env=" envelope/" xmlns:ns1="urn:masservice" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" applications/invoke/v1_0/" xmlns:ns5="urn:maswsutilityapi" xmlns:xsd=" xmlns:xsi=" <SOAP-ENV:Header/> <SOAP- ENV:Body> <ns3:administrativecommandresponse> <AdministrativeQueryItem> <Item> </Item> </ AdministrativeQueryItem> </AdministrativeQueryItem> <Item> </Item> </AdministrativeQueryItem> </ AdministrativeQueryItem> <Item> </Item> </ AdministrativeQueryItem> </AdministrativeQueryItem> <Item> </Item> </AdministrativeQueryItem> </ AdministrativeQueryItem> <Item> mmf </Item> </ AdministrativeQueryItem> </AdministrativeQueryItem> <Item> Avaya </ Item> </AdministrativeQueryItem> </AdministrativeQueryItem> <Item> </Item> </AdministrativeQueryItem> </ 20 Fundamentals - Web Services 3 Dec 2010

21 CreateContentGroup example ns3:administrativecommandresponse> </SOAP-ENV:Body> </SOAP- ENV:Envelope> CreateContentGroup example <soapenv:envelope xmlns:soapenv=" envelope/" xmlns:v1=" content_store/v1_0/"> <soapenv:header/> <soapenv:body> <v1:administrativecommand> <Operation> CreateContentGroup </ Operation> <NameSpace> Avaya< /NameSpace> <ContentGroup> Music </ ContentGroup> </v1:administrativecommand> </soapenv:body> </ soapenv:envelope> <SOAP-ENV:Envelope xmlns:soap-enc=" encoding/" xmlns:soap-env=" envelope/" xmlns:ns1="urn:masservice" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" applications/invoke/v1_0/" xmlns:ns5="urn:maswsutilityapi" xmlns:xsd=" xmlns:xsi=" <<SOAP-ENV:Header/> <SOAP- ENV:Body> <ns3:administrativecommandresponse/> </SOAP-ENV:Body> </ SOAP-ENV:Envelope> CopyContentGroup example In the following example, all of the content in the Avaya Namespace folder Music is copied to the Avaya Namespace folder Music/Rock. Before copy is completed, the folder structure is: Avaya Music file1 file2 file3 file4 After the copy is complete, the folder structure is: Avaya Music file1 file2 file3 file4 Music/Rock file1 file2 file3 file4 <soapenv:envelope xmlns:soapenv=" envelope/" xmlns:v1=" content_store/v1_0/"> <soapenv:header/> <soapenv:body> <v1:administrativecommand> <Operation> CopyContentGroup </Operation <NameSpace> Avaya </NameSpace> <ContentGroup> Music </ContentGroup> Fundamentals - Web Services 3 Dec

22 Content Store Web Service <CopyToNamespace> Avaya< /CopyToNamespace> <CopyToContentGroup> Music/Rock </CopyToContentGroup> </v1:administrativecommand> </ soapenv:body> </soapenv:envelope> <SOAP-ENV:Envelope xmlns:soap-enc=" encoding/" xmlns:soap-env=" envelope/" xmlns:ns1="urn:masservice" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" applications/invoke/v1_0/" xmlns:ns5="urn:maswsutilityapi" xmlns:xsd=" xmlns:xsi=" <SOAP-ENV:Header/> <SOAP- ENV:Body> <ns3:administrativecommandresponse/> </SOAP-ENV:Body> </ SOAP-ENV:Envelope> QueryNamespaceSize example <soapenv:envelope xmlns:soapenv=" envelope/" xmlns:v1=" content_store/v1_0/"> <soapenv:header/> <soapenv:body> <v1:administrativecommand> <Operation> QueryNamespaceSize </ Operation> <NameSpace> Avaya </NameSpace> </ v1:administrativecommand> </soapenv:body> </soapenv:envelope> <SOAP-ENV:Envelope xmlns:soap-enc=" encoding/" xmlns:soap-env=" envelope/" xmlns:ns1="urn:masservice" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" applications/invoke/v1_0/" xmlns:ns5="urn:maswsutilityapi" xmlns:xsd=" xmlns:xsi=" <SOAP-ENV:Header/> <SOAP- ENV:Body> <ns3:administrativecommandresponse> <Result> </ Result> </ns3:administrativecommandresponse> </SOAP-ENV:Body> </ SOAP-ENV:Envelope> 22 Fundamentals - Web Services 3 Dec 2010

23 IngestContent operation IngestContent operation The Content Store obtains content by instructed ingestion where applications specify the URL location of the data to be ingested. The supported URLs are file://, and rtft://. The Content Store pulls data from the specified location and stores it locally in a mass storage array. Clients can provide an explicit Content ID for easy reference to the XML file with out keeping track of content store assigned IDs. The application must ensure Content IDs are unique within the Content Group. The ingest operation updates existing content (reingest) by overwriting the old content in the same Content Group (the Content ID to be updated must be specified in the request). XML content is ingested like other content with one additional condition. XML can be specified entirely in the XML Body parameter of the IngestContent request or by a URL. The Content Store provides direct content references for clients to retrieve files from the Content Store using the URL types file:// and rtft://. However, the FetchContent command can be used for content access and uses references for large content that cannot be included in the response itself. Request Ingest can also be a request to reserve a Content ID on the Content Store for data at a later time (preingest). For preingest, a new Content ID is returned to the client and the Content ID should be included in the request for the full ingest. The following table describes the parameters of the IngestContent request. Table 6: IngestContent request parameters Parameter Requirements Description Namespace Mandatory Namespace containing the Content Groups to receive the file. ContentGroup Mandatory The Content Groups to receive the file specified by URL. ContentId Conditional The name of the content. ContentId is not included for initial Ingest or preingest if Content IDs are assigned by the Content Store to ensure uniqueness. ContentID is required after initial Ingest or preingest when ingest is updating content. Fundamentals - Web Services 3 Dec

24 Content Store Web Service Parameter Requirements Description OpaqueFrom Optional Metadata field. Any string can be stored here. OpaqueType Optional Metadata field. Any integer can be stored here OpaqueGroup Optional Metadata field. Any string can be stored here. OpaqueData Optional Metadata field. Any string can be stored here. OpaqueStatus Optional Metadata field. Any integer can be stored here. OpaqueStatus can indicate if a message is new or not. For example: 1 new 0 not new Priority Optional Metadata field. Any integer can be stored here. MetaDataMode Optional Client metadata on the Content Store is under client control. For reingests to update existing content, Clients can choose to do one of the following: Purge all existing metadata., Metadata included in the reingest is used exclusively. Preserve all existing metadata, but overwrite old metadata if new values are provided in the reingest for a particular field. The default is Preserve. URL Conditional URL of the file to be ingested as new content. Valid URLs are file://, rtft://. The URL is not included for preingest modes since the URL of the file to be ingested comes in a subsequent ingest message. This parameter cannot be included if XML Body is included. Base64Content Optional For future use. Base64ContentFileExte nsion Optional For future use. ExpirationTime Optional Time when the content is automatically marked deleted by the Content Store. The time is in the GMT time zone and expiration time is formatted as yyyy-mm-dd hh:mm:ss XMLDocument Conditional Entire body of the XML document to be stored on the Content Store. Alternatively, the XML document may be specified by the URL parameter. This parameter cannot be included if the URL is included. Gslid Optional Global Session Log Identifier for tracing a transaction. 24 Fundamentals - Web Services 3 Dec 2010

25 Response Response The following table describes the parameters of the IngestContent response. Table 7: IngestContent response parameters Parameter Requirements Description Content ID Mandatory The Content ID assigned to the ingested file. File URL Mandatory The file:// URL based location on the Content Store where the content can be pulled from. RTFT URL Mandatory The rtft:// URL based location on the Content Store where the content can be pulled from. IngestContent examples The following are examples of the IngestContent command. IngestContent example with Content ID specified <soapenv:envelope xmlns:soapenv=" envelope/" xmlns:v1=" content_store/v1_0/"> <soapenv:header/> <soapenv:body> <v1:ingestcontent> <NameSpace> Avaya </NameSpace> <ContentGroup> Music/Rock </ContentGroup> <ContentId> Jump </ContentId> <Url> /jump.wav </Url> <OpaqueFrom> MusicStore </OpaqueFrom> <OpaqueGroup> New Releases </OpaqueGroup> </v1:ingestcontent> </ soapenv:body> </soapenv:envelope> <SOAP-ENV:Envelope xmlns:soap-enc=" encoding/" xmlns:soap-env=" envelope/" xmlns:ns1="urn:masservice" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" applications/invoke/v1_0/" xmlns:ns5="urn:maswsutilityapi" xmlns:xsd=" xmlns:xsi=" <SOAP-ENV:Header/> <SOAP- Fundamentals - Web Services 3 Dec

26 Content Store Web Service ENV:Body> <ns3:ingestcontentresponse> <ContentId> Jump </ContentId> <FILEUrl> file://d:/program Files/Avaya/Multimedia_Applications/MAS/platdata/ CStore/StorageRoot/n /c wav </FILEUrl> <RTFTUrl> rtft:// :52007/root0/n / c wav </RTFTUrl> </ns3:ingestcontentresponse> </ SOAP-ENV:Body> </SOAP-ENV:Envelope> IngestContent example with reingest The following is a reingest example with updated meta data. The file name returned is new, but the Content ID to reference it remains the same. <soapenv:envelope xmlns:soapenv=" envelope/" xmlns:v1=" content_store/v1_0/"> <soapenv:header/> <soapenv:body> <v1:ingestcontent> <NameSpace> Avaya </NameSpace> <ContentGroup> Music/Rock </ContentGroup> <ContentId> Jump </ContentId> <MetaDataMode> Preserve </MetaDataMode> <Url> jump.wav </Url> <OpaqueFrom> MusicStore </OpaqueFrom> <OpaqueGroup> Old Songs </OpaqueGroup> </v1:ingestcontent> </soapenv:body> </ soapenv:envelope> <SOAP-ENV:Envelope xmlns:soap-enc=" encoding/" xmlns:soap-env=" envelope/" xmlns:ns1="urn:masservice" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" applications/invoke/v1_0/" xmlns:ns5="urn:maswsutilityapi" xmlns:xsd=" xmlns:xsi=" <SOAP-ENV:Header/> <SOAP- ENV:Body> <ns3:ingestcontentresponse> <ContentId> Jump </ContentId> <FILEUrl> file://d:/program Files/Avaya/Multimedia_Applications/MAS/platdata/ CStore/StorageRoot/n /c wav </FILEUrl> <RTFTUrl> rtft:// :52007/root0/n / c wav </RTFTUrl> </ns3:ingestcontentresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> 26 Fundamentals - Web Services 3 Dec 2010

27 IngestContent example with no Content ID specified IngestContent example with no Content ID specified The following is an XML ingest example with no Content ID specified and a generated ID returned. The generated Content ID is in the response and the XMLDocument parameter is used in the request. A file is created with the XML content. Note that you may need to use <! [CDATA[ ]]> for the XML content. <soapenv:envelope xmlns:soapenv=" envelope/" xmlns:v1=" content_store/v1_0/"> <soapenv:header/> <soapenv:body> <v1:ingestcontent> <NameSpace> Avaya </NameSpace> <ContentGroup> Music/Rock </ContentGroup> <OpaqueFrom> MusicStore </OpaqueFrom> <OpaqueGroup> Play list </OpaqueGroup> <XMLDocument> <xml><song>jump</ song><artist>van Halen</artist></xml> </XMLDocument> </v1:ingestcontent> </soapenv:body> </soapenv:envelope> <SOAP-ENV:Envelope xmlns:soap-enc=" encoding/" xmlns:soap-env=" envelope/" xmlns:ns1="urn:masservice" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" applications/invoke/v1_0/" xmlns:ns5="urn:maswsutilityapi" xmlns:xsd=" xmlns:xsi=" <SOAP-ENV:Header/> <SOAP- ENV:Body> <ns3:ingestcontentresponse> <ContentId> c </ContentId> <FILEUrl> file://d:/program Files/ Avaya/Multimedia_Applications/MAS/platdata/CStore/StorageRoot/n / c xml </FILEUrl> <RTFTUrl> rtft:// :52007/ root0/n /c xml </RTFTUrl> </ ns3:ingestcontentresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> FetchContent operation The FetchContent command retrieves previously ingested file content from the Content Store. Fundamentals - Web Services 3 Dec

28 Content Store Web Service Request The following table describes the parameters of the FetchContent request. Table 8: FetchContent request parameters Parameter Requirements Description Namespace Mandatory Namespace that contains the Content Group. ContentGroup Mandatory Content Group that contains the content. ContentId Mandatory Content Id to fetch. Gslid Optional Global Session Log Identifier tracing a transaction. Response The following table describes the parameters of the FetchContent response. Table 9: FetchContent response parameters Parameter Requirements Description ContentId Mandatory ContentId of the data returned. SizeBytes Mandatory Number of bytes in the data. MimeType Optional Type of resource returned. HTTPUrl Conditional HTTP URL if the file is too long. FetchContent example <soapenv:envelope xmlns:soapenv=" envelope/" xmlns:v1=" content_store/v1_0/"> <soapenv:header/> <soapenv:body> <v1:fetchcontent> <NameSpace> Avaya </NameSpace> <ContentGroup> Music/Rock </ContentGroup> <ContentId> Jump </ContentId> </ v1:fetchcontent> </soapenv:body> </soapenv:envelope> <SOAP-ENV:Envelope xmlns:soap-enc=" encoding/" xmlns:soap-env=" 28 Fundamentals - Web Services 3 Dec 2010

29 SearchContent operation envelope/" xmlns:ns1="urn:masservice" xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" applications/invoke/v1_0/" xmlns:ns5="urn:maswsutilityapi" xmlns:xsd=" xmlns:xsi=" <SOAP-ENV:Header/> <SOAP- ENV:Body> <ns3:fetchcontentresponse> <ContentId> Jump </ContentId> <SizeBytes> 51 </SizeBytes> <MimeType>text/xml</MimeType> <Base64Content> PHhtbD48c29uZz5KdW1wPC9zb25nPj xzb25nplbob3rvz3jhcgg8l3nvbmc+pc94bww+ </Base64Content> </ ns3:fetchcontentresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Decoding the Base64Content in the response yields the original XML: <xml><song>jump</ song><artist>vanhalen</artist></xml> SearchContent operation The SearchContent command queries the Content Store for data matching specified criteria within a single particular Content Group. The response contains a list of Content IDs that matched the criteria and one optional piece of requestor selected meta data associated with the matching content. Request The following table describes the parameters of the SearchContent request. Table 10: SearchContent request parameters Parameter Requirement s Description Namespace Mandatory Namespace that contains the Content Group to search. ContentGroup Mandatory Content Group to search. SortKey Optional The user can specify an attribute to be the sort key for the returned result set. Valid values are: Group, Type, From, UserData, Status, Deleted, Priority, Size, TimeRcvd, ExpTime, and LastAccTime. Fundamentals - Web Services 3 Dec

30 Content Store Web Service Parameter Requirement s Description ResultOrder Optional Determines the order of the results returned. The options available are Descending or Ascending. The default is Ascending. OpaqueFrom Optional Client Metadata string. If this field is included, the response only includes content that has identical values for this field and any other fields specified in this request. OpaqueType Optional Client Metadata integer. If this field is included, the response only includes content that has identical values for this field and any other fields specified in this request. OpaqueGroup Optional Client Metadata string. If this field is included, the response only includes content that has identical values for this field and any other fields specified in this request. OpaqueData Optional Opaque string, client metadata. If this field is included, the response only includes content that has identical values for this field and any other fields specified in this request. OpaqueStatus Optional Client Metadata integer. If this field is included, the response only includes content that has identical values for this field and any other fields specified in this request. Deleted Optional 1 deleted. 0 not marked deleted. If this field is included, the response only includes content that has identical values for this field and any other fields specified in this request. Priority Optional Client Metadata integer. If this field is included, the response only includes content that has identical values for this field and any other fields specified in this request. MimeType Optional File type. Including this field means the response will only include content which has identical values for this field and any other fields specified in this request. TimeReceived Optional GMT time formatted as yyyy-mm-dd hh:mm:ss that identifies the time received at the Content Store. For example: :20:03 If this field is included, the response only includes content that has identical values for this field and any others specified in the request. LastAccessTime Optional Time when this content was last modified. The format is GMT time as yyyy-mm-dd hh:mm:ss. 30 Fundamentals - Web Services 3 Dec 2010