EMC Documentum PlatformRESTServices - emc PlatformRESTServices Version7.2 DevelopmentGuide EMCCorporation CorporateHeadquarters Hopkinton,MA01748-9103 1

  • View
    277

  • Download
    4

Embed Size (px)

Text of EMC Documentum PlatformRESTServices - emc PlatformRESTServices Version7.2 DevelopmentGuide...

  • EMC DocumentumPlatform REST Services

    Version 7.2

    Development Guide

    EMC CorporationCorporate Headquarters

    Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

  • Legal Notice

    Copyright 2013 2016 EMC Corporation. All Rights Reserved.

    EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

    THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

    Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

    For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarksused herein are the property of their respective owners.

    Documentation Feedback

    Your opinion matters. We want to hear from you regarding our product documentation. If you have feedbackabout how we can make our documentation better or easier to use, please send us your feedback directly atECD.Documentation.Feedback@emc.com

  • Table of Contents

    Preface ................................................................................................................................ 11

    Chapter 1 Overview ..................................................................................................... 13Understanding RESTful Programming............................................................... 13Relations with Other Documentum Platform APIs .............................................. 14

    Chapter 2 Deploy Documentum REST Services .......................................................... 15

    Chapter 3 General REST Definitions ............................................................................ 17Common Definition - HTTP Headers ................................................................. 17Common Definition - Query Parameters ............................................................ 19HTTP Status Codes........................................................................................... 22Supported MIME Types .................................................................................... 23Other Types ................................................................................................. 23Media Type for Home Document............................................................... 23MIME Type for Content ............................................................................ 23Multipart Type ......................................................................................... 24

    URL Extension ............................................................................................. 24Content Type of an Entry in a Feed ................................................................ 24

    URI and URL ................................................................................................... 25HTTP Methods................................................................................................. 26Web Client Caching .......................................................................................... 26Representation ................................................................................................. 26Collection Resource ...................................................................................... 27Embedded Entry .......................................................................................... 30Single Resource ............................................................................................ 33Multi-part Request Representation ................................................................ 35Error Representation..................................................................................... 36Transaction Support...................................................................................... 38

    Notes to PUT and POST Operation .................................................................... 38Runtime Property Configuration ....................................................................... 38Batch Operations .............................................................................................. 38

    Chapter 4 Resource Specific Features ........................................................................ 41Filter Expression............................................................................................... 41Literals ........................................................................................................ 41Numeric Literal ........................................................................................ 41String Literal ............................................................................................ 42Boolean Literal ......................................................................................... 42Datetime Literal ....................................................................................... 43

    Functions ..................................................................................................... 44starts-with................................................................................................ 44contains ................................................................................................... 44

    3

  • Table of Contents

    between ................................................................................................... 45type ......................................................................................................... 45nilled ....................................................................................................... 46

    Logical Operators ......................................................................................... 47Comparison Operators.................................................................................. 47Comparison with Multiple Values ............................................................. 48Comparison with Repeating Properties ...................................................... 48

    Filter Expression Examples ........................................................................... 49Property View .................................................................................................. 49Predefined View Expression.......................................................................... 49Custom View Expression .............................................................................. 50View Expression Syntax ................................................................................ 50

    NULL in REST ................................................................................................. 51NULL Value Representation.......................................................................... 51

    Whitespace in XML .......................................................................................... 52Thumbnail Link................................................................................................ 53Feed Pagination................................................................................................ 55Full Text Query in Collection Resources ............................................................. 55Simple Search Language ................................................................................... 56Words.......................................................................................................... 57Phrases ........................................................................................................ 57Implicit AND ............................................................................................... 57Boolean Operators ........................................................................................ 57Wildcards .................................................................................................... 58

    Facet Search ..................................................................................................... 58Generating Link Relation in DQL Results ........................................................... 60Additional Information about Generating Links ............................................ 61Thumbnail support....................................................................................... 62

    Chapter 5 Authentication ............................................................................................. 67HTTP Basic Authentication ............................................................................... 67Enabling HTTP Basic Authentication ............................................................. 69User Credential Mapping.............................................................................. 69Known Limitation ........................................................................................ 69

    Authentication with SPNEGO-based Kerberos ................................................... 70Authentication Workflow.............................................................................. 70Multi Domain Support within a Forest........................................................... 71Setup SPNEGO-based Kerberos..................................................................... 73Content Server Configuration for SPNEGO-based Kerberos ........................ 73REST Server Configuration for SPNEGO-based Kerberos ............................ 73Register and Map

Recommended

View more >