Library Resources API

API change history

List of APIs related to Library Resources

Get logs by module

Get list of audit logs by module. It is used by user with "LibraryAdmin" role.

Try it

Request

Request URL

Request parameters

  • string

    Format - uuid. Module ID

  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

  • (optional)
    string

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns list of audit logs information

Representations

{
  "type": "array",
  "items": {
    "description": "The class which is used for display all folder contents audit logs for a module.",
    "type": "object",
    "properties": {
      "auditID": {
        "format": "int64",
        "description": "audit id",
        "type": "integer"
      },
      "id": {
        "format": "uuid",
        "description": "The module id",
        "type": "string"
      },
      "folderID": {
        "format": "uuid",
        "description": "The folder id",
        "type": "string"
      },
      "contentID": {
        "format": "uuid",
        "description": "file or url ID if any",
        "type": "string"
      },
      "folderName": {
        "description": "The folder name",
        "type": "string"
      },
      "action": {
        "description": "Action of the audit log",
        "type": "string"
      },
      "logDate": {
        "format": "date-time",
        "description": "The date when the log is created",
        "type": "string"
      },
      "userID": {
        "format": "uuid",
        "description": "The id of the who created the log",
        "type": "string"
      },
      "userName": {
        "description": "The name of the user who created the log",
        "type": "string"
      },
      "fileNameOrUrl": {
        "description": "The file name or url if any",
        "type": "string"
      },
      "details": {
        "description": "other details if any",
        "type": "string"
      }
    }
  }
}
[
  {
    "auditID": 0,
    "id": "string",
    "folderID": "string",
    "contentID": "string",
    "folderName": "string",
    "action": "string",
    "logDate": "string",
    "userID": "string",
    "userName": "string",
    "fileNameOrUrl": "string",
    "details": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "The class which is used for display all folder contents audit logs for a module.",
    "type": "object",
    "properties": {
      "auditID": {
        "format": "int64",
        "description": "audit id",
        "type": "integer"
      },
      "id": {
        "format": "uuid",
        "description": "The module id",
        "type": "string"
      },
      "folderID": {
        "format": "uuid",
        "description": "The folder id",
        "type": "string"
      },
      "contentID": {
        "format": "uuid",
        "description": "file or url ID if any",
        "type": "string"
      },
      "folderName": {
        "description": "The folder name",
        "type": "string"
      },
      "action": {
        "description": "Action of the audit log",
        "type": "string"
      },
      "logDate": {
        "format": "date-time",
        "description": "The date when the log is created",
        "type": "string"
      },
      "userID": {
        "format": "uuid",
        "description": "The id of the who created the log",
        "type": "string"
      },
      "userName": {
        "description": "The name of the user who created the log",
        "type": "string"
      },
      "fileNameOrUrl": {
        "description": "The file name or url if any",
        "type": "string"
      },
      "details": {
        "description": "other details if any",
        "type": "string"
      }
    }
  }
}
[
  {
    "auditID": 0,
    "id": "string",
    "folderID": "string",
    "contentID": "string",
    "folderName": "string",
    "action": "string",
    "logDate": "string",
    "userID": "string",
    "userName": "string",
    "fileNameOrUrl": "string",
    "details": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "The class which is used for display all folder contents audit logs for a module.",
    "type": "object",
    "properties": {
      "auditID": {
        "format": "int64",
        "description": "audit id",
        "type": "integer"
      },
      "id": {
        "format": "uuid",
        "description": "The module id",
        "type": "string"
      },
      "folderID": {
        "format": "uuid",
        "description": "The folder id",
        "type": "string"
      },
      "contentID": {
        "format": "uuid",
        "description": "file or url ID if any",
        "type": "string"
      },
      "folderName": {
        "description": "The folder name",
        "type": "string"
      },
      "action": {
        "description": "Action of the audit log",
        "type": "string"
      },
      "logDate": {
        "format": "date-time",
        "description": "The date when the log is created",
        "type": "string"
      },
      "userID": {
        "format": "uuid",
        "description": "The id of the who created the log",
        "type": "string"
      },
      "userName": {
        "description": "The name of the user who created the log",
        "type": "string"
      },
      "fileNameOrUrl": {
        "description": "The file name or url if any",
        "type": "string"
      },
      "details": {
        "description": "other details if any",
        "type": "string"
      }
    }
  }
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://luminus.azure-api.net/nus_lib/{id}/Audits?sortby={string}&offset={integer}&limit={integer}&where={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["sortby"] = "{string}";
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["where"] = "{string}";
            var uri = "https://luminus.azure-api.net/nus_lib/{id}/Audits?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/nus_lib/{id}/Audits");

            builder.setParameter("sortby", "{string}");
            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("where", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "sortby": "{string}",
            "offset": "{integer}",
            "limit": "{integer}",
            "where": "{string}",
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/nus_lib/{id}/Audits?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://luminus.azure-api.net/nus_lib/{id}/Audits";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"sortby={string}",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"where={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://luminus.azure-api.net/nus_lib/{id}/Audits');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/nus_lib/{id}/Audits?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/nus_lib/{id}/Audits?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://luminus.azure-api.net/nus_lib/{id}/Audits')

query = URI.encode_www_form({
    # Request parameters
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body