Details

      Description

      As a developer using the REST API I want to retrieve a list of children (via primary parent/child assoc) for a node in the repository so that I can build a basic browsing client.

      Acceptance Criteria

      • Does the /nodes/nodeId/children URL return a 200 response with a list of nodes? Yes
      • Is a minimal representation (as shown below) of each child node returned by default? Yes
      • Can additional information (eg. aspectName, properties, path & isLink) be returned for each child node be specified by the client via a include query parameter? Yes
      • Can less information be returned (to save bandwith) for each child node be specified by the client via a properties query parameter? Yes
      • Can the information returned be ordered using an orderBy query parameter, with up to three properties in the orderBy clause (isFolder, name, sizeInBytes, mimeType, nodeType, modifiedAt, createdAt, modifiedByUser, createdByUser + other properties, eg. cm:title, ...) ? Yes
      • Can the information returned be paginated using the skipCount and maxItems query parameters? Yes
      • Can the information returned be filtered using the where query parameters, using "isFolder=true" or "isFolder=false" (see also RA-811 & RA-828) ?
      • Does the /nodes/nodeId/children URL return a 400 response if the nodeId path parameter does not represent a folder? Yes
      • Does the /nodes/nodeId/children URL return a 404 response if the nodeId path parameter does not exist? Yes

      Example Minimal Node Representation
      NOTE: The content property will only be present for files. The isFolder property will be true for folders.

      {
         "createdAt": "2015-11-19T11:08:42.004+0000", 
         "createdByUser": {
            "displayName": "Joe Bloggs", 
            "id": "jbloggs"
         }, 
         "id": "99532d84-d540-410c-b52a-c2131cf33589", 
         "isFolder": false, 
         "modifiedAt": "2015-11-19T11:08:42.004+0000", 
         "modifiedByUser": {
            "displayName": "Joe Bloggs", 
            "id": "jbloggs"
         }, 
         "name": "file.txt",
         "nodeType": "cm:content", 
         "parentId": "9afcc003-3911-4f75-a974-a163cc43c986",
         "content": {
            "encoding": "UTF-8", 
            "mimeType": "plain/text", 
            "mimeTypeName": "Plain Text",    
            "sizeInBytes": 32
         }
      }
      

      Reference Material
      https://docs.google.com/document/d/1zMMO9I0-9PnoNdirbLH2Lmogh68rM4ZhAd56hvcc5KY

        Attachments

          Issue Links

            Structure

              Activity

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  gcornwell Gavin Cornwell [X] (Inactive)
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Structure Helper Panel