Skip to main content

​
URL structure

where {organisationId} is the ID of an organisation.

​
Supported methods and overview

  • GET - retrieves a list of information for all API-based requests made to the Cocoon Data Platform’s Access Service, within the scope of an organisation (specified by organisationId).

​
Detailed description

This API endpoint retrieves a list of information for all API-based requests made to the Cocoon Data Platform’s Access Service, within the scope of an organisation (specified by organisationId).

​
Supported roles and conditions

This API endpoint supports requests utilising Cocoon Data user accounts with the following roles (as described in the Organisation Administrator’s Guide) and conditions:
  • Organisation administrator - when this user is a member of the organisation specified by the {organisationId} of the request’s URL.
The Cocoon Data Platform’s resources available to a Cocoon Data user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.

​
Required headers

The appropriate access token as the Bearer token:
  • Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

​
Optional parameters

The following optional parameters can be sent in the URL of the GET request:
  • limit - An integer value from 0 to 100, representing the maximum number of items to be returned in the response, where an individual item is information about an API-based request to the Access Service in the organisation (specified by {organisationId} in this request’s URL). If this parameter is omitted, then its value is 0 by default, which does not apply restrictions to the number of items returned in the response.
  • offset - A value representing the count order of all retrievable items (i.e. API-based requests in the organisation specified by {organisationId} in the URL) returned in the response. Calls to this API endpoint may amount to potentially large numbers of items being returned from the Cocoon Data Platform. Since the order of these items in the response could differ significantly, based on the values of the orderBy and sortBy parameters below, this offset parameter provides pagination for items returned in responses, allowing items to be retrieved from any count greater than 0 (i.e. the first item returned in a response). If this parameter is omitted, then its value is 0 by default.
  • orderBy - An enumeration (enum) value representing the order in which items (i.e. API-based requests in the organisation specified by {organisationId} in the URL) are returned in the response. This parameter orders items according to the value of the sortBy parameter specified below. Ordering items can be in either ascending alphanumeric order (by specifying the value ASC for this parameter) or descending order (by specifying the value DESC). If this parameter is omitted, then its value is ASC by default.
  • searchText - A text substring of URL ‘sub-parameters’ and their values, which are used to filter all items (in the response). Each sub-parameter and its value is separated by an escaped ‘=’ sign (%3D) and each sub-parameter + value pair is separated from the next by an escaped ‘&’ sign (%26). One or more of the following sub-parameters can be specified:
    • startTime - Specify a date in the format DD/MM/YYYY, where each ‘/’ sign is escaped (%2F).
    • endTime - Specify a later date in the same format as that used for startTime.
    • clientId - Specify the client ID of a client application configured on the Cocoon Data Platform.
    • email - Specify the email address of a Cocoon Data user account whose access token was submitted in the header of the API-based requests.
    • action - Specify the sub-parameter value:
      • CREATED - for API-based POST method requests,
      • RETRIEVED - for API-based GET method requests,
      • UPDATED - for API-based PUT method requests,
      • DELETED - for API-based DELETE method requests.
    • apiType - Specify the sub-parameter value:
      • AUTH - for API-based requests relating to authentication and authorisation,
      • COLLABORATIONS - for API-based requests relating to collaborators,
      • COLLECTIONS - for API-based requests relating to folders,
      • CONTACTS - for API-based requests relating to contacts,
      • KEYS - for API-based requests relating to keys,
      • NOTIFICATIONS - for API-based requests relating to email notifications,
      • OBJECTS - for API-based requests relating to file objects,
      • USERS - for API-based requests relating to users.
  • sortBy - .
    Example (request):

​
Returns

If the request succeeded, then an HTTP response status 200 OK is returned. For successful requests only, a JSON-formatted response containing the following members is also returned:
  • items - .
    • created - .
    • ipAddress - .
    • username - .
    • action - .
    • resource - .
    • queryString - .
    • eventInfo - .
    • status - .
    • clientInfo - .
    • statusDescription - .
    • clientIdString - .
    • i18nActionString - .
    • actionString - .
    • eventInfoAsPlainText - .
    • id - .
  • count - .
  • offset - .
    Example (response):