Details

    • Type: Story
    • Status: Closed (View Workflow)
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: ACS 5.2
    • Component/s: REST API
    • Labels:
      None

      Description

      As a developer using the REST API I want to retrieve a list of shared links in the system so that I can build a client that displays a list of publicly shared links.

      Acceptance Criteria

      • The /shared-links URL accepts a GET request and returns a 200 response with a list of shared links
      • A default representation (as shown below) of each rendition is returned
      • The include parameter can be used to include allowableOperations in the response
      • The allowableOperations list contains "delete" if applicable for currently authenticated user (see A/C for RA-750)
      • The shared links returned include all those for which the current user has read permission to the content
      • The shared links returned are ordered by the modifiedAt property with the most recently modified appearing first
      • The shared links returned can be paginated using the skipCount and maxItems query parameters
      • The shared links returned can be filtered with the where query parameter using "sharedByUser={personId}" (where personId can also be "-me-")
      • The list of shared links returned are eventually consistent
      • The endpoint returns a 501 (Not Implemented) response if the shared links feature is disabled

      Example Request

      GET .../shared-links?include=allowableOperations
      

      Example Response

      {
        "list": {
          "pagination": {
            "count": 2,
            "hasMoreItems": false,
            "totalItems": 2,
            "skipCount": 0,
            "maxItems": 100
          },
          "entries": [
            {
              "entry": {
                "modifiedAt": "2016-01-19T15:45:03.271+0000",
                "modifiedByUser": {
                  "id": "fsmith",
                  "displayName": "Fred Smith"
                },
                "name": "Golfy Tree Light-1.jpg",
                "id": "VoaJXWx3QbWcU4gE3vgJbw",
                "nodeId": "90c6a53f-2950-4814-8b60-85d3600e1ffa",
                "sharedByUser": {
                  "id": "jbloggs",
                  "displayName": "Joe Bloggs"
                },
                "content": {
                  "mimeType": "image/jpeg",
                  "mimeTypeName: "JPG",
                  "sizeInBytes": 261958
                },
                "allowableOperations": [
                   "delete"
                ]
              }
            },
            {
              "entry": {
                "modifiedAt": "2016-01-20T13:24:48.834+0000",
                "modifiedByUser": {
                  "id": "admin",
                  "displayName": "Administrator"
                },
                "name": "2048.jpg",
                "id": "7zUkxsHkRPioTzpeOxjl8w",
                "nodeId": "d019b383-63b6-49fe-ab9e-acea994748a9",
                "sharedByUser": {
                  "id": "jbloggs",
                  "displayName": "Joe Bloggs"
                },
                "content": {
                  "mimeType": "image/jpeg",
                  "mimeTypeName": "JPG",
                  "sizeInBytes": 125600
                },
                "allowableOperations": [
                   "delete"
                ]
              }
            }
          ]
        }
      }
      

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                gcornwell Gavin Cornwell
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: