Laserfiche API

AccessTokens

The AccessToken methods are currently still marked version v1-alpha. Version 1 will follow the OAuth model.

Create Access Token

- Creates an access token for use with the Laserfiche API. - Provides credentials and uses the access token returned with subsequent API calls as a means of authorization. - Adding createCookie=true as a query parameter results a response that includes a Set-Cookie header containing an authToken value. The default value for createCookie is false.


/v1-alpha/Repositories/{repoId}/AccessTokens/Create

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.laserfiche.com/repository/v1-alpha/Repositories/{repoId}/AccessTokens/Create?createCookie=&customerId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessTokensApi;

import java.io.File;
import java.util.*;

public class AccessTokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AccessTokensApi apiInstance = new AccessTokensApi();
        String repoId = repoId_example; // String | The requested repository ID.
        CreateConnectionRequest body = {
  "summary" : "Authenticate using username and password",
  "description" : "For ACS authentication, username and password can be placed in the request body with customerId in query parameter and an auth token will be returned in the response. An optional application name can also be set.",
  "value" : {
    "username" : "username value",
    "password" : "password value",
    "applicationName" : ""
  }
}; // CreateConnectionRequest | The username and password used to create the session connection.
        Boolean createCookie = true; // Boolean | An optional query parameter used to indicate whether a Set-Cookie header containing
            the authToken is returned in the response.
        String customerId = customerId_example; // String | The Laserfiche Cloud account ID to use when using username and password to create a session connection.
        try {
            SessionKeyInfo result = apiInstance.create_Access_Token(repoId, body, createCookie, customerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessTokensApi#create_Access_Token");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessTokensApi;

public class AccessTokensApiExample {

    public static void main(String[] args) {
        AccessTokensApi apiInstance = new AccessTokensApi();
        String repoId = repoId_example; // String | The requested repository ID.
        CreateConnectionRequest body = {
  "summary" : "Authenticate using username and password",
  "description" : "For ACS authentication, username and password can be placed in the request body with customerId in query parameter and an auth token will be returned in the response. An optional application name can also be set.",
  "value" : {
    "username" : "username value",
    "password" : "password value",
    "applicationName" : ""
  }
}; // CreateConnectionRequest | The username and password used to create the session connection.
        Boolean createCookie = true; // Boolean | An optional query parameter used to indicate whether a Set-Cookie header containing
            the authToken is returned in the response.
        String customerId = customerId_example; // String | The Laserfiche Cloud account ID to use when using username and password to create a session connection.
        try {
            SessionKeyInfo result = apiInstance.create_Access_Token(repoId, body, createCookie, customerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessTokensApi#create_Access_Token");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.
CreateConnectionRequest *body = {
  "summary" : "Authenticate using username and password",
  "description" : "For ACS authentication, username and password can be placed in the request body with customerId in query parameter and an auth token will be returned in the response. An optional application name can also be set.",
  "value" : {
    "username" : "username value",
    "password" : "password value",
    "applicationName" : ""
  }
}; // The username and password used to create the session connection. (optional)
Boolean *createCookie = true; // An optional query parameter used to indicate whether a Set-Cookie header containing
            the authToken is returned in the response. (optional)
String *customerId = customerId_example; // The Laserfiche Cloud account ID to use when using username and password to create a session connection. (optional)

AccessTokensApi *apiInstance = [[AccessTokensApi alloc] init];

[apiInstance create_Access_TokenWith:repoId
    body:body
    createCookie:createCookie
    customerId:customerId
              completionHandler: ^(SessionKeyInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.AccessTokensApi()
var repoId = repoId_example; // {{String}} The requested repository ID.
var opts = { 
  'body': {
  "summary" : "Authenticate using username and password",
  "description" : "For ACS authentication, username and password can be placed in the request body with customerId in query parameter and an auth token will be returned in the response. An optional application name can also be set.",
  "value" : {
    "username" : "username value",
    "password" : "password value",
    "applicationName" : ""
  }
} // {{CreateConnectionRequest}} The username and password used to create the session connection.
  'createCookie': true // {{Boolean}} An optional query parameter used to indicate whether a Set-Cookie header containing
            the authToken is returned in the response.
  'customerId': customerId_example // {{String}} The Laserfiche Cloud account ID to use when using username and password to create a session connection.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.create_Access_Token(repoId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class create_Access_TokenExample
    {
        public void main()
        {


            var apiInstance = new AccessTokensApi();
            var repoId = repoId_example;  // String | The requested repository ID.
            var body = new CreateConnectionRequest(); // CreateConnectionRequest | The username and password used to create the session connection. (optional) 
            var createCookie = true;  // Boolean | An optional query parameter used to indicate whether a Set-Cookie header containing
            the authToken is returned in the response. (optional) 
            var customerId = customerId_example;  // String | The Laserfiche Cloud account ID to use when using username and password to create a session connection. (optional) 

            try
            {
                SessionKeyInfo result = apiInstance.create_Access_Token(repoId, body, createCookie, customerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessTokensApi.create_Access_Token: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccessTokensApi();
$repoId = repoId_example; // String | The requested repository ID.
$body = {
  "summary" : "Authenticate using username and password",
  "description" : "For ACS authentication, username and password can be placed in the request body with customerId in query parameter and an auth token will be returned in the response. An optional application name can also be set.",
  "value" : {
    "username" : "username value",
    "password" : "password value",
    "applicationName" : ""
  }
}; // CreateConnectionRequest | The username and password used to create the session connection.
$createCookie = true; // Boolean | An optional query parameter used to indicate whether a Set-Cookie header containing
            the authToken is returned in the response.
$customerId = customerId_example; // String | The Laserfiche Cloud account ID to use when using username and password to create a session connection.

try {
    $result = $api_instance->create_Access_Token($repoId, $body, $createCookie, $customerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessTokensApi->create_Access_Token: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessTokensApi;


my $api_instance = WWW::SwaggerClient::AccessTokensApi->new();
my $repoId = repoId_example; # String | The requested repository ID.
my $body = WWW::SwaggerClient::Object::CreateConnectionRequest->new(); # CreateConnectionRequest | The username and password used to create the session connection.
my $createCookie = true; # Boolean | An optional query parameter used to indicate whether a Set-Cookie header containing
            the authToken is returned in the response.
my $customerId = customerId_example; # String | The Laserfiche Cloud account ID to use when using username and password to create a session connection.

eval { 
    my $result = $api_instance->create_Access_Token(repoId => $repoId, body => $body, createCookie => $createCookie, customerId => $customerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessTokensApi->create_Access_Token: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AccessTokensApi()
repoId = repoId_example # String | The requested repository ID.
body = {
  "summary" : "Authenticate using username and password",
  "description" : "For ACS authentication, username and password can be placed in the request body with customerId in query parameter and an auth token will be returned in the response. An optional application name can also be set.",
  "value" : {
    "username" : "username value",
    "password" : "password value",
    "applicationName" : ""
  }
} # CreateConnectionRequest | The username and password used to create the session connection. (optional)
createCookie = true # Boolean | An optional query parameter used to indicate whether a Set-Cookie header containing
            the authToken is returned in the response. (optional)
customerId = customerId_example # String | The Laserfiche Cloud account ID to use when using username and password to create a session connection. (optional)

try: 
    api_response = api_instance.create_access_token(repoId, body=body, createCookie=createCookie, customerId=customerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccessTokensApi->create_Access_Token: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required
Body parameters
Name Description
body
Query parameters
Name Description
createCookie
Boolean
An optional query parameter used to indicate whether a Set-Cookie header containing the authToken is returned in the response.
customerId
String
The Laserfiche Cloud account ID to use when using username and password to create a session connection.

Responses

Status: 200 - Create an authorizationToken successfuly.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 429 - Rate limit is reached.


Invalidate Access Token

- Invalidates the access token. - Acts as a "logout" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session.


/v1-alpha/Repositories/{repoId}/AccessTokens/Invalidate

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1-alpha/Repositories/{repoId}/AccessTokens/Invalidate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessTokensApi;

import java.io.File;
import java.util.*;

public class AccessTokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AccessTokensApi apiInstance = new AccessTokensApi();
        String repoId = repoId_example; // String | The requested repository ID.
        try {
            ODataValueOfBoolean result = apiInstance.invalidate_Access_Token(repoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessTokensApi#invalidate_Access_Token");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessTokensApi;

public class AccessTokensApiExample {

    public static void main(String[] args) {
        AccessTokensApi apiInstance = new AccessTokensApi();
        String repoId = repoId_example; // String | The requested repository ID.
        try {
            ODataValueOfBoolean result = apiInstance.invalidate_Access_Token(repoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessTokensApi#invalidate_Access_Token");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.

AccessTokensApi *apiInstance = [[AccessTokensApi alloc] init];

[apiInstance invalidate_Access_TokenWith:repoId
              completionHandler: ^(ODataValueOfBoolean output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.AccessTokensApi()
var repoId = repoId_example; // {{String}} The requested repository ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.invalidate_Access_Token(repoId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class invalidate_Access_TokenExample
    {
        public void main()
        {


            var apiInstance = new AccessTokensApi();
            var repoId = repoId_example;  // String | The requested repository ID.

            try
            {
                ODataValueOfBoolean result = apiInstance.invalidate_Access_Token(repoId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessTokensApi.invalidate_Access_Token: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccessTokensApi();
$repoId = repoId_example; // String | The requested repository ID.

try {
    $result = $api_instance->invalidate_Access_Token($repoId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessTokensApi->invalidate_Access_Token: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessTokensApi;


my $api_instance = WWW::SwaggerClient::AccessTokensApi->new();
my $repoId = repoId_example; # String | The requested repository ID.

eval { 
    my $result = $api_instance->invalidate_Access_Token(repoId => $repoId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessTokensApi->invalidate_Access_Token: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AccessTokensApi()
repoId = repoId_example # String | The requested repository ID.

try: 
    api_response = api_instance.invalidate_access_token(repoId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccessTokensApi->invalidate_Access_Token: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required

Responses

Status: 200 - Invalidate the authorizationToken successfully.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 429 - Rate limit is reached.


Refresh Access Token

- Refreshes the session associated with the access token. - When a client application wants to keep an idle session alive, this route should be used to refresh the expiration timer associated with the access token. - Optionally, a Keep-Alive header can be included with the request to specify how long the session should be kept alive when idle. The maximum timeout value is 1 hour.


/v1-alpha/Repositories/{repoId}/AccessTokens/Refresh

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1-alpha/Repositories/{repoId}/AccessTokens/Refresh"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessTokensApi;

import java.io.File;
import java.util.*;

public class AccessTokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AccessTokensApi apiInstance = new AccessTokensApi();
        String repoId = repoId_example; // String | The requested repository ID.
        String keepAlive = keepAlive_example; // String | An optional Keep-Alive header with timeout value can be used to specify how long the
            session should be kept alive when idle. The maximum timeout value is 1 hour.
        try {
            ODataValueOfDateTime result = apiInstance.refresh_Access_Token(repoId, keepAlive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessTokensApi#refresh_Access_Token");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessTokensApi;

public class AccessTokensApiExample {

    public static void main(String[] args) {
        AccessTokensApi apiInstance = new AccessTokensApi();
        String repoId = repoId_example; // String | The requested repository ID.
        String keepAlive = keepAlive_example; // String | An optional Keep-Alive header with timeout value can be used to specify how long the
            session should be kept alive when idle. The maximum timeout value is 1 hour.
        try {
            ODataValueOfDateTime result = apiInstance.refresh_Access_Token(repoId, keepAlive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessTokensApi#refresh_Access_Token");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.
String *keepAlive = keepAlive_example; // An optional Keep-Alive header with timeout value can be used to specify how long the
            session should be kept alive when idle. The maximum timeout value is 1 hour. (optional)

AccessTokensApi *apiInstance = [[AccessTokensApi alloc] init];

[apiInstance refresh_Access_TokenWith:repoId
    keepAlive:keepAlive
              completionHandler: ^(ODataValueOfDateTime output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.AccessTokensApi()
var repoId = repoId_example; // {{String}} The requested repository ID.
var opts = { 
  'keepAlive': keepAlive_example // {{String}} An optional Keep-Alive header with timeout value can be used to specify how long the
            session should be kept alive when idle. The maximum timeout value is 1 hour.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refresh_Access_Token(repoId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class refresh_Access_TokenExample
    {
        public void main()
        {


            var apiInstance = new AccessTokensApi();
            var repoId = repoId_example;  // String | The requested repository ID.
            var keepAlive = keepAlive_example;  // String | An optional Keep-Alive header with timeout value can be used to specify how long the
            session should be kept alive when idle. The maximum timeout value is 1 hour. (optional) 

            try
            {
                ODataValueOfDateTime result = apiInstance.refresh_Access_Token(repoId, keepAlive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessTokensApi.refresh_Access_Token: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccessTokensApi();
$repoId = repoId_example; // String | The requested repository ID.
$keepAlive = keepAlive_example; // String | An optional Keep-Alive header with timeout value can be used to specify how long the
            session should be kept alive when idle. The maximum timeout value is 1 hour.

try {
    $result = $api_instance->refresh_Access_Token($repoId, $keepAlive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessTokensApi->refresh_Access_Token: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessTokensApi;


my $api_instance = WWW::SwaggerClient::AccessTokensApi->new();
my $repoId = repoId_example; # String | The requested repository ID.
my $keepAlive = keepAlive_example; # String | An optional Keep-Alive header with timeout value can be used to specify how long the
            session should be kept alive when idle. The maximum timeout value is 1 hour.

eval { 
    my $result = $api_instance->refresh_Access_Token(repoId => $repoId, keepAlive => $keepAlive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessTokensApi->refresh_Access_Token: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AccessTokensApi()
repoId = repoId_example # String | The requested repository ID.
keepAlive = keepAlive_example # String | An optional Keep-Alive header with timeout value can be used to specify how long the
            session should be kept alive when idle. The maximum timeout value is 1 hour. (optional)

try: 
    api_response = api_instance.refresh_access_token(repoId, keepAlive=keepAlive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccessTokensApi->refresh_Access_Token: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required
Header parameters
Name Description
Keep-Alive
String
An optional Keep-Alive header with timeout value can be used to specify how long the session should be kept alive when idle. The maximum timeout value is 1 hour.

Responses

Status: 200 - Refresh the session successfully.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 429 - Rate limit is reached.


Attributes

Get Trustee Attribute Key Value Pairs

Get the attribute key value pairs associated with the authenticated user.

- Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the "Everyone" group. - Attribute keys can be used with subsequent calls to get specific attribute values. - Allowed OData query options: Select, count, orderby. Optional query parameters : everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the "Everyone" group. Note when this true, this response does not include both the "Everyone" groups attribute and the currently authenticated user, but only the "Everyone" groups.


/v1/Repositories/{repoId}/Attributes

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Attributes?everyone=&$select=&$orderby=&$count="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttributesApi;

import java.io.File;
import java.util.*;

public class AttributesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AttributesApi apiInstance = new AttributesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Boolean everyone = true; // Boolean | Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user.
        String $select = $select_example; // String | Limits the properties returned in the result.
        String $orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
        Boolean $count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.
        try {
            ODataValueOfListOfAttribute result = apiInstance.get_trustee_attribute_key_value_pairs(repoId, everyone, $select, $orderby, $count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttributesApi#get_trustee_attribute_key_value_pairs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttributesApi;

public class AttributesApiExample {

    public static void main(String[] args) {
        AttributesApi apiInstance = new AttributesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Boolean everyone = true; // Boolean | Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user.
        String $select = $select_example; // String | Limits the properties returned in the result.
        String $orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
        Boolean $count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.
        try {
            ODataValueOfListOfAttribute result = apiInstance.get_trustee_attribute_key_value_pairs(repoId, everyone, $select, $orderby, $count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttributesApi#get_trustee_attribute_key_value_pairs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository id.
Boolean *everyone = true; // Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user. (optional)
String *$select = $select_example; // Limits the properties returned in the result. (optional)
String *$orderby = $orderby_example; // Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
Boolean *$count = true; // Indicates whether the total count of items within a collection are returned in the result. (optional)

AttributesApi *apiInstance = [[AttributesApi alloc] init];

// Get the attribute key value pairs associated with the authenticated user.
[apiInstance get_trustee_attribute_key_value_pairsWith:repoId
    everyone:everyone
    $select:$select
    $orderby:$orderby
    $count:$count
              completionHandler: ^(ODataValueOfListOfAttribute output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.AttributesApi()
var repoId = repoId_example; // {{String}} The requested repository id.
var opts = { 
  'everyone': true, // {{Boolean}} Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user.
  '$select': $select_example, // {{String}} Limits the properties returned in the result.
  '$orderby': $orderby_example, // {{String}} Specifies the order in which items are returned. The maximum number of expressions is 5.
  '$count': true // {{Boolean}} Indicates whether the total count of items within a collection are returned in the result.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_trustee_attribute_key_value_pairs(repoId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class get_trustee_attribute_key_value_pairsExample
    {
        public void main()
        {


            var apiInstance = new AttributesApi();
            var repoId = repoId_example;  // String | The requested repository id.
            var everyone = true;  // Boolean | Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user. (optional) 
            var $select = $select_example;  // String | Limits the properties returned in the result. (optional) 
            var $orderby = $orderby_example;  // String | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional) 
            var $count = true;  // Boolean | Indicates whether the total count of items within a collection are returned in the result. (optional) 

            try
            {
                // Get the attribute key value pairs associated with the authenticated user.
                ODataValueOfListOfAttribute result = apiInstance.get_trustee_attribute_key_value_pairs(repoId, everyone, $select, $orderby, $count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttributesApi.get_trustee_attribute_key_value_pairs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAttributesApi();
$repoId = repoId_example; // String | The requested repository id.
$everyone = true; // Boolean | Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user.
$$select = $select_example; // String | Limits the properties returned in the result.
$$orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
$$count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.

try {
    $result = $api_instance->get_trustee_attribute_key_value_pairs($repoId, $everyone, $$select, $$orderby, $$count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttributesApi->get_trustee_attribute_key_value_pairs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttributesApi;


my $api_instance = WWW::SwaggerClient::AttributesApi->new();
my $repoId = repoId_example; # String | The requested repository id.
my $everyone = true; # Boolean | Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user.
my $$select = $select_example; # String | Limits the properties returned in the result.
my $$orderby = $orderby_example; # String | Specifies the order in which items are returned. The maximum number of expressions is 5.
my $$count = true; # Boolean | Indicates whether the total count of items within a collection are returned in the result.

eval { 
    my $result = $api_instance->get_trustee_attribute_key_value_pairs(repoId => $repoId, everyone => $everyone, $select => $$select, $orderby => $$orderby, $count => $$count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttributesApi->get_trustee_attribute_key_value_pairs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AttributesApi()
repoId = repoId_example # String | The requested repository id.
everyone = true # Boolean | Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user. (optional)
$select = $select_example # String | Limits the properties returned in the result. (optional)
$orderby = $orderby_example # String | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
$count = true # Boolean | Indicates whether the total count of items within a collection are returned in the result. (optional)

try: 
    # Get the attribute key value pairs associated with the authenticated user.
    api_response = api_instance.get_trustee_attribute_key_value_pairs(repoId, everyone=everyone, $select=$select, $orderby=$orderby, $count=$count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttributesApi->get_trustee_attribute_key_value_pairs: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository id.
Required
Query parameters
Name Description
everyone
Boolean
Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user.
$select
String
Limits the properties returned in the result.
$orderby
String
Specifies the order in which items are returned. The maximum number of expressions is 5.
$count
Boolean
Indicates whether the total count of items within a collection are returned in the result.

Responses

Status: 200 - Get trustee attribute keys successfully.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 429 - Rate limit is reached.


Get Trustee Attribute Value by Key

Get an attribute object by key associated with the authenticated user.

- Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within "Everyone" group. - Optional query parameters : everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried.


/v1/Repositories/{repoId}/Attributes/{attributeKey}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Attributes/{attributeKey}?everyone="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttributesApi;

import java.io.File;
import java.util.*;

public class AttributesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AttributesApi apiInstance = new AttributesApi();
        String repoId = repoId_example; // String | The requested repository id.
        String attributeKey = attributeKey_example; // String | The requested attribute key.
        Boolean everyone = true; // Boolean | Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user.
        try {
            Attribute result = apiInstance.get_trustee_attribute_value_by_key(repoId, attributeKey, everyone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttributesApi#get_trustee_attribute_value_by_key");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttributesApi;

public class AttributesApiExample {

    public static void main(String[] args) {
        AttributesApi apiInstance = new AttributesApi();
        String repoId = repoId_example; // String | The requested repository id.
        String attributeKey = attributeKey_example; // String | The requested attribute key.
        Boolean everyone = true; // Boolean | Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user.
        try {
            Attribute result = apiInstance.get_trustee_attribute_value_by_key(repoId, attributeKey, everyone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttributesApi#get_trustee_attribute_value_by_key");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository id.
String *attributeKey = attributeKey_example; // The requested attribute key.
Boolean *everyone = true; // Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user. (optional)

AttributesApi *apiInstance = [[AttributesApi alloc] init];

// Get an attribute object by key associated with the authenticated user.
[apiInstance get_trustee_attribute_value_by_keyWith:repoId
    attributeKey:attributeKey
    everyone:everyone
              completionHandler: ^(Attribute output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.AttributesApi()
var repoId = repoId_example; // {{String}} The requested repository id.
var attributeKey = attributeKey_example; // {{String}} The requested attribute key.
var opts = { 
  'everyone': true // {{Boolean}} Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_trustee_attribute_value_by_key(repoId, attributeKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class get_trustee_attribute_value_by_keyExample
    {
        public void main()
        {


            var apiInstance = new AttributesApi();
            var repoId = repoId_example;  // String | The requested repository id.
            var attributeKey = attributeKey_example;  // String | The requested attribute key.
            var everyone = true;  // Boolean | Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user. (optional) 

            try
            {
                // Get an attribute object by key associated with the authenticated user.
                Attribute result = apiInstance.get_trustee_attribute_value_by_key(repoId, attributeKey, everyone);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttributesApi.get_trustee_attribute_value_by_key: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAttributesApi();
$repoId = repoId_example; // String | The requested repository id.
$attributeKey = attributeKey_example; // String | The requested attribute key.
$everyone = true; // Boolean | Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user.

try {
    $result = $api_instance->get_trustee_attribute_value_by_key($repoId, $attributeKey, $everyone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttributesApi->get_trustee_attribute_value_by_key: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttributesApi;


my $api_instance = WWW::SwaggerClient::AttributesApi->new();
my $repoId = repoId_example; # String | The requested repository id.
my $attributeKey = attributeKey_example; # String | The requested attribute key.
my $everyone = true; # Boolean | Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user.

eval { 
    my $result = $api_instance->get_trustee_attribute_value_by_key(repoId => $repoId, attributeKey => $attributeKey, everyone => $everyone);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttributesApi->get_trustee_attribute_value_by_key: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AttributesApi()
repoId = repoId_example # String | The requested repository id.
attributeKey = attributeKey_example # String | The requested attribute key.
everyone = true # Boolean | Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user. (optional)

try: 
    # Get an attribute object by key associated with the authenticated user.
    api_response = api_instance.get_trustee_attribute_value_by_key(repoId, attributeKey, everyone=everyone)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttributesApi->get_trustee_attribute_value_by_key: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository id.
Required
attributeKey*
String
The requested attribute key.
Required
Query parameters
Name Description
everyone
Boolean
Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user.

Responses

Status: 200 - Get trustee attribute value successfully.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Requested attribute key not found.

Status: 429 - Rate limit is reached.


AuditReasons

Get Audit Reasons

Get the audit reasons associated with the authenticated user.

- Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included. - Only includes audit reasons associated with available API functionalities, like delete entry and export document. - If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included.


/v1/Repositories/{repoId}/AuditReasons

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/AuditReasons"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuditReasonsApi;

import java.io.File;
import java.util.*;

public class AuditReasonsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AuditReasonsApi apiInstance = new AuditReasonsApi();
        String repoId = repoId_example; // String | The requested repository ID.
        try {
            AuditReasons result = apiInstance.get_Audit_Reasons(repoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditReasonsApi#get_Audit_Reasons");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuditReasonsApi;

public class AuditReasonsApiExample {

    public static void main(String[] args) {
        AuditReasonsApi apiInstance = new AuditReasonsApi();
        String repoId = repoId_example; // String | The requested repository ID.
        try {
            AuditReasons result = apiInstance.get_Audit_Reasons(repoId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditReasonsApi#get_Audit_Reasons");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.

AuditReasonsApi *apiInstance = [[AuditReasonsApi alloc] init];

// Get the audit reasons associated with the authenticated user.
[apiInstance get_Audit_ReasonsWith:repoId
              completionHandler: ^(AuditReasons output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.AuditReasonsApi()
var repoId = repoId_example; // {{String}} The requested repository ID.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_Audit_Reasons(repoId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class get_Audit_ReasonsExample
    {
        public void main()
        {


            var apiInstance = new AuditReasonsApi();
            var repoId = repoId_example;  // String | The requested repository ID.

            try
            {
                // Get the audit reasons associated with the authenticated user.
                AuditReasons result = apiInstance.get_Audit_Reasons(repoId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuditReasonsApi.get_Audit_Reasons: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAuditReasonsApi();
$repoId = repoId_example; // String | The requested repository ID.

try {
    $result = $api_instance->get_Audit_Reasons($repoId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditReasonsApi->get_Audit_Reasons: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuditReasonsApi;


my $api_instance = WWW::SwaggerClient::AuditReasonsApi->new();
my $repoId = repoId_example; # String | The requested repository ID.

eval { 
    my $result = $api_instance->get_Audit_Reasons(repoId => $repoId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuditReasonsApi->get_Audit_Reasons: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AuditReasonsApi()
repoId = repoId_example # String | The requested repository ID.

try: 
    # Get the audit reasons associated with the authenticated user.
    api_response = api_instance.get_audit_reasons(repoId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditReasonsApi->get_Audit_Reasons: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required

Responses

Status: 200 - Get audit reasons successfully.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 429 - Rate limit is reached.


Entries

Assign Entry Links

- Assign links to an entry. - Provide an entry ID and a list of links to assign to that entry. - This is an overwrite action. The request must include all links to assign to the entry, including existing links that should remain assigned to the entry.


/v1/Repositories/{repoId}/Entries/{entryId}/links

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/links"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The request repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        array[PutLinksRequest] body = ; // array[PutLinksRequest] | 
        try {
            ODataValueOfIListOfWEntryLinkInfo result = apiInstance.assign_Entry_Links(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#assign_Entry_Links");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The request repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        array[PutLinksRequest] body = ; // array[PutLinksRequest] | 
        try {
            ODataValueOfIListOfWEntryLinkInfo result = apiInstance.assign_Entry_Links(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#assign_Entry_Links");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The request repository ID.
Integer *entryId = 56; // The requested entry ID.
array[PutLinksRequest] *body = ; //  (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance assign_Entry_LinksWith:repoId
    entryId:entryId
    body:body
              completionHandler: ^(ODataValueOfIListOfWEntryLinkInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The request repository ID.
var entryId = 56; // {{Integer}} The requested entry ID.
var opts = { 
  'body':  // {{array[PutLinksRequest]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.assign_Entry_Links(repoIdentryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assign_Entry_LinksExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The request repository ID.
            var entryId = 56;  // Integer | The requested entry ID.
            var body = new array[PutLinksRequest](); // array[PutLinksRequest] |  (optional) 

            try
            {
                ODataValueOfIListOfWEntryLinkInfo result = apiInstance.assign_Entry_Links(repoId, entryId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.assign_Entry_Links: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The request repository ID.
$entryId = 56; // Integer | The requested entry ID.
$body = ; // array[PutLinksRequest] | 

try {
    $result = $api_instance->assign_Entry_Links($repoId, $entryId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->assign_Entry_Links: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The request repository ID.
my $entryId = 56; # Integer | The requested entry ID.
my $body = [WWW::SwaggerClient::Object::array[PutLinksRequest]->new()]; # array[PutLinksRequest] | 

eval { 
    my $result = $api_instance->assign_Entry_Links(repoId => $repoId, entryId => $entryId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->assign_Entry_Links: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The request repository ID.
entryId = 56 # Integer | The requested entry ID.
body =  # array[PutLinksRequest] |  (optional)

try: 
    api_response = api_instance.assign_entry_links(repoId, entryId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->assign_Entry_Links: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The request repository ID.
Required
entryId*
Integer (int32)
The requested entry ID.
Required
Body parameters
Name Description
body

Responses

Status: 200 - Assign links to an entry successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request entry id not found.

Status: 423 - Entry is locked.

Status: 429 - Rate limit is reached.


Assign Field Values

- Update field values assigned to an entry. - Provide the new field values to assign to the entry, and remove/reset all previously assigned field values. - This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset.


/v1/Repositories/{repoId}/Entries/{entryId}/fields

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/fields"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The entry ID of the entry that will have its fields updated.
        map[String, FieldToUpdate] body = ; // map[String, FieldToUpdate] | 
        try {
            ODataValueOfIListOfFieldValue result = apiInstance.assign_Field_Values(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#assign_Field_Values");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The entry ID of the entry that will have its fields updated.
        map[String, FieldToUpdate] body = ; // map[String, FieldToUpdate] | 
        try {
            ODataValueOfIListOfFieldValue result = apiInstance.assign_Field_Values(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#assign_Field_Values");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.
Integer *entryId = 56; // The entry ID of the entry that will have its fields updated.
map[String, FieldToUpdate] *body = ; //  (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance assign_Field_ValuesWith:repoId
    entryId:entryId
    body:body
              completionHandler: ^(ODataValueOfIListOfFieldValue output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository ID.
var entryId = 56; // {{Integer}} The entry ID of the entry that will have its fields updated.
var opts = { 
  'body':  // {{map[String, FieldToUpdate]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.assign_Field_Values(repoIdentryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assign_Field_ValuesExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository ID.
            var entryId = 56;  // Integer | The entry ID of the entry that will have its fields updated.
            var body = new map[String, FieldToUpdate](); // map[String, FieldToUpdate] |  (optional) 

            try
            {
                ODataValueOfIListOfFieldValue result = apiInstance.assign_Field_Values(repoId, entryId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.assign_Field_Values: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository ID.
$entryId = 56; // Integer | The entry ID of the entry that will have its fields updated.
$body = ; // map[String, FieldToUpdate] | 

try {
    $result = $api_instance->assign_Field_Values($repoId, $entryId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->assign_Field_Values: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository ID.
my $entryId = 56; # Integer | The entry ID of the entry that will have its fields updated.
my $body = WWW::SwaggerClient::Object::map[String, FieldToUpdate]->new(); # map[String, FieldToUpdate] | 

eval { 
    my $result = $api_instance->assign_Field_Values(repoId => $repoId, entryId => $entryId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->assign_Field_Values: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository ID.
entryId = 56 # Integer | The entry ID of the entry that will have its fields updated.
body =  # map[String, FieldToUpdate] |  (optional)

try: 
    api_response = api_instance.assign_field_values(repoId, entryId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->assign_Field_Values: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required
entryId*
Integer (int32)
The entry ID of the entry that will have its fields updated.
Required
Body parameters
Name Description
body

Responses

Status: 200 - Update field values successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Requested entry id not found.

Status: 423 - Entry is locked.

Status: 429 - Rate limit is reached.


Assign Tags

- Assign tags to an entry. - Provide an entry ID and a list of tags to assign to that entry. - This is an overwrite action. The request must include all tags to assign to the entry, including existing tags that should remain assigned to the entry.


/v1/Repositories/{repoId}/Entries/{entryId}/tags

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/tags"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        PutTagRequest body = ; // PutTagRequest | The tags to add.
        try {
            ODataValueOfIListOfWTagInfo result = apiInstance.assign_Tags(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#assign_Tags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        PutTagRequest body = ; // PutTagRequest | The tags to add.
        try {
            ODataValueOfIListOfWTagInfo result = apiInstance.assign_Tags(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#assign_Tags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.
Integer *entryId = 56; // The requested entry ID.
PutTagRequest *body = ; // The tags to add. (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance assign_TagsWith:repoId
    entryId:entryId
    body:body
              completionHandler: ^(ODataValueOfIListOfWTagInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository ID.
var entryId = 56; // {{Integer}} The requested entry ID.
var opts = { 
  'body':  // {{PutTagRequest}} The tags to add.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.assign_Tags(repoIdentryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assign_TagsExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository ID.
            var entryId = 56;  // Integer | The requested entry ID.
            var body = new PutTagRequest(); // PutTagRequest | The tags to add. (optional) 

            try
            {
                ODataValueOfIListOfWTagInfo result = apiInstance.assign_Tags(repoId, entryId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.assign_Tags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository ID.
$entryId = 56; // Integer | The requested entry ID.
$body = ; // PutTagRequest | The tags to add.

try {
    $result = $api_instance->assign_Tags($repoId, $entryId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->assign_Tags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository ID.
my $entryId = 56; # Integer | The requested entry ID.
my $body = WWW::SwaggerClient::Object::PutTagRequest->new(); # PutTagRequest | The tags to add.

eval { 
    my $result = $api_instance->assign_Tags(repoId => $repoId, entryId => $entryId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->assign_Tags: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository ID.
entryId = 56 # Integer | The requested entry ID.
body =  # PutTagRequest | The tags to add. (optional)

try: 
    api_response = api_instance.assign_tags(repoId, entryId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->assign_Tags: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required
entryId*
Integer (int32)
The requested entry ID.
Required
Body parameters
Name Description
body

Responses

Status: 200 - Assign tags to an entry successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request id not found.

Status: 423 - Entry is locked.

Status: 429 - Rate limit is reached.


Copy Entry Async

- Copy a new child entry in the designated folder async, and potentially return an operationToken. - Provide the parent folder id, and copy an entry as a child of the designated folder. - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. - The status of the operation can be checked via the Tasks/{operationToken} route.


/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Folder/CopyAsync

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Folder/CopyAsync?autoRename="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The folder id that the entry will be created in.
        CopyAsyncRequest body = {
  "summary" : "Copy an entry",
  "description" : "We can copy an entry (marked by sourceId property) to a destination (marked in URL).",
  "value" : {
    "sourceId" : 123,
    "name" : "CopiedEntry"
  }
}; // CopyAsyncRequest | Copy entry request.
        Boolean autoRename = true; // Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.
        try {
            AcceptedOperation result = apiInstance.copy_entry_async(repoId, entryId, body, autoRename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#copy_entry_async");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The folder id that the entry will be created in.
        CopyAsyncRequest body = {
  "summary" : "Copy an entry",
  "description" : "We can copy an entry (marked by sourceId property) to a destination (marked in URL).",
  "value" : {
    "sourceId" : 123,
    "name" : "CopiedEntry"
  }
}; // CopyAsyncRequest | Copy entry request.
        Boolean autoRename = true; // Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.
        try {
            AcceptedOperation result = apiInstance.copy_entry_async(repoId, entryId, body, autoRename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#copy_entry_async");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository id.
Integer *entryId = 56; // The folder id that the entry will be created in.
CopyAsyncRequest *body = {
  "summary" : "Copy an entry",
  "description" : "We can copy an entry (marked by sourceId property) to a destination (marked in URL).",
  "value" : {
    "sourceId" : 123,
    "name" : "CopiedEntry"
  }
}; // Copy entry request. (optional)
Boolean *autoRename = true; // An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false. (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance copy_entry_asyncWith:repoId
    entryId:entryId
    body:body
    autoRename:autoRename
              completionHandler: ^(AcceptedOperation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository id.
var entryId = 56; // {{Integer}} The folder id that the entry will be created in.
var opts = { 
  'body': {
  "summary" : "Copy an entry",
  "description" : "We can copy an entry (marked by sourceId property) to a destination (marked in URL).",
  "value" : {
    "sourceId" : 123,
    "name" : "CopiedEntry"
  }
} // {{CopyAsyncRequest}} Copy entry request.
  'autoRename': true // {{Boolean}} An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.copy_entry_async(repoIdentryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class copy_entry_asyncExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository id.
            var entryId = 56;  // Integer | The folder id that the entry will be created in.
            var body = new CopyAsyncRequest(); // CopyAsyncRequest | Copy entry request. (optional) 
            var autoRename = true;  // Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false. (optional) 

            try
            {
                AcceptedOperation result = apiInstance.copy_entry_async(repoId, entryId, body, autoRename);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.copy_entry_async: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository id.
$entryId = 56; // Integer | The folder id that the entry will be created in.
$body = {
  "summary" : "Copy an entry",
  "description" : "We can copy an entry (marked by sourceId property) to a destination (marked in URL).",
  "value" : {
    "sourceId" : 123,
    "name" : "CopiedEntry"
  }
}; // CopyAsyncRequest | Copy entry request.
$autoRename = true; // Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.

try {
    $result = $api_instance->copy_entry_async($repoId, $entryId, $body, $autoRename);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->copy_entry_async: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository id.
my $entryId = 56; # Integer | The folder id that the entry will be created in.
my $body = WWW::SwaggerClient::Object::CopyAsyncRequest->new(); # CopyAsyncRequest | Copy entry request.
my $autoRename = true; # Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.

eval { 
    my $result = $api_instance->copy_entry_async(repoId => $repoId, entryId => $entryId, body => $body, autoRename => $autoRename);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->copy_entry_async: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository id.
entryId = 56 # Integer | The folder id that the entry will be created in.
body = {
  "summary" : "Copy an entry",
  "description" : "We can copy an entry (marked by sourceId property) to a destination (marked in URL).",
  "value" : {
    "sourceId" : 123,
    "name" : "CopiedEntry"
  }
} # CopyAsyncRequest | Copy entry request. (optional)
autoRename = true # Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false. (optional)

try: 
    api_response = api_instance.copy_entry_async(repoId, entryId, body=body, autoRename=autoRename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->copy_entry_async: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository id.
Required
entryId*
Integer (int32)
The folder id that the entry will be created in.
Required
Body parameters
Name Description
body
Query parameters
Name Description
autoRename
Boolean
An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.

Responses

Status: 201 - Copy entry operation is started successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request entry id not found.

Status: 409 - Entry name conflicts.

Status: 429 - Operation limit or request limit reached.


Create or Copy Entry

- Create/copy a new child entry in the designated folder. - Provide the parent folder id, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder. - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.


/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Folder/children

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Folder/children?autoRename="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The folder id that the entry will be created in.
        PostEntryChildrenRequest body = {
  "summary" : "Create a folder",
  "description" : "We can create a new folder with the given name.",
  "value" : {
    "entryType" : "Folder",
    "name" : "NewFolder"
  }
}; // PostEntryChildrenRequest | The entry to create.
        Boolean autoRename = true; // Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.
        try {
            Entry result = apiInstance.create_or_copy_entry(repoId, entryId, body, autoRename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#create_or_copy_entry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The folder id that the entry will be created in.
        PostEntryChildrenRequest body = {
  "summary" : "Create a folder",
  "description" : "We can create a new folder with the given name.",
  "value" : {
    "entryType" : "Folder",
    "name" : "NewFolder"
  }
}; // PostEntryChildrenRequest | The entry to create.
        Boolean autoRename = true; // Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.
        try {
            Entry result = apiInstance.create_or_copy_entry(repoId, entryId, body, autoRename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#create_or_copy_entry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository id.
Integer *entryId = 56; // The folder id that the entry will be created in.
PostEntryChildrenRequest *body = {
  "summary" : "Create a folder",
  "description" : "We can create a new folder with the given name.",
  "value" : {
    "entryType" : "Folder",
    "name" : "NewFolder"
  }
}; // The entry to create. (optional)
Boolean *autoRename = true; // An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false. (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance create_or_copy_entryWith:repoId
    entryId:entryId
    body:body
    autoRename:autoRename
              completionHandler: ^(Entry output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository id.
var entryId = 56; // {{Integer}} The folder id that the entry will be created in.
var opts = { 
  'body': {
  "summary" : "Create a folder",
  "description" : "We can create a new folder with the given name.",
  "value" : {
    "entryType" : "Folder",
    "name" : "NewFolder"
  }
} // {{PostEntryChildrenRequest}} The entry to create.
  'autoRename': true // {{Boolean}} An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.create_or_copy_entry(repoIdentryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class create_or_copy_entryExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository id.
            var entryId = 56;  // Integer | The folder id that the entry will be created in.
            var body = new PostEntryChildrenRequest(); // PostEntryChildrenRequest | The entry to create. (optional) 
            var autoRename = true;  // Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false. (optional) 

            try
            {
                Entry result = apiInstance.create_or_copy_entry(repoId, entryId, body, autoRename);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.create_or_copy_entry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository id.
$entryId = 56; // Integer | The folder id that the entry will be created in.
$body = {
  "summary" : "Create a folder",
  "description" : "We can create a new folder with the given name.",
  "value" : {
    "entryType" : "Folder",
    "name" : "NewFolder"
  }
}; // PostEntryChildrenRequest | The entry to create.
$autoRename = true; // Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.

try {
    $result = $api_instance->create_or_copy_entry($repoId, $entryId, $body, $autoRename);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->create_or_copy_entry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository id.
my $entryId = 56; # Integer | The folder id that the entry will be created in.
my $body = WWW::SwaggerClient::Object::PostEntryChildrenRequest->new(); # PostEntryChildrenRequest | The entry to create.
my $autoRename = true; # Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false.

eval { 
    my $result = $api_instance->create_or_copy_entry(repoId => $repoId, entryId => $entryId, body => $body, autoRename => $autoRename);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->create_or_copy_entry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository id.
entryId = 56 # Integer | The folder id that the entry will be created in.
body = {
  "summary" : "Create a folder",
  "description" : "We can create a new folder with the given name.",
  "value" : {
    "entryType" : "Folder",
    "name" : "NewFolder"
  }
} # PostEntryChildrenRequest | The entry to create. (optional)
autoRename = true # Boolean | An optional query parameter used to indicate if the new entry should be automatically
            renamed if an entry already exists with the given name in the folder. The default value is false. (optional)

try: 
    api_response = api_instance.create_or_copy_entry(repoId, entryId, body=body, autoRename=autoRename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->create_or_copy_entry: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository id.
Required
entryId*
Integer (int32)
The folder id that the entry will be created in.
Required
Body parameters
Name Description
body
Query parameters
Name Description
autoRename
Boolean
An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.

Responses

Status: 201 - Created a new child entry successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request entry id not found.

Status: 409 - Entry name conflicts.

Status: 429 - Rate limit is reached.


Delete Assigned Template

- Remove the currently assigned template from the specified entry. - Provide an entry id to clear template value on. - If the entry does not have a template assigned, no change will be made.


/v1/Repositories/{repoId}/Entries/{entryId}/template

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/template"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The id of the entry that will have its template removed.
        try {
            Entry result = apiInstance.delete_assigned_template(repoId, entryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#delete_assigned_template");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The id of the entry that will have its template removed.
        try {
            Entry result = apiInstance.delete_assigned_template(repoId, entryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#delete_assigned_template");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository id.
Integer *entryId = 56; // The id of the entry that will have its template removed.

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance delete_assigned_templateWith:repoId
    entryId:entryId
              completionHandler: ^(Entry output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository id.
var entryId = 56; // {{Integer}} The id of the entry that will have its template removed.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delete_assigned_template(repoId, entryId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class delete_assigned_templateExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository id.
            var entryId = 56;  // Integer | The id of the entry that will have its template removed.

            try
            {
                Entry result = apiInstance.delete_assigned_template(repoId, entryId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.delete_assigned_template: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository id.
$entryId = 56; // Integer | The id of the entry that will have its template removed.

try {
    $result = $api_instance->delete_assigned_template($repoId, $entryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->delete_assigned_template: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository id.
my $entryId = 56; # Integer | The id of the entry that will have its template removed.

eval { 
    my $result = $api_instance->delete_assigned_template(repoId => $repoId, entryId => $entryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->delete_assigned_template: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository id.
entryId = 56 # Integer | The id of the entry that will have its template removed.

try: 
    api_response = api_instance.delete_assigned_template(repoId, entryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->delete_assigned_template: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository id.
Required
entryId*
Integer (int32)
The id of the entry that will have its template removed.
Required

Responses

Status: 200 - Remove the currently assigned template successfully.

Status: 401 - Access token is invalid or expired.

Status: 404 - Request entry id not found.

Status: 423 - Entry is locked.

Status: 429 - Rate limit is reached.


Delete Entry

- Begins a task to delete an entry, and returns an operationToken. - Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately. - Optionally include an audit reason ID and comment in the JSON body. This route returns an operationToken, and will run as an asynchronous operation. Check the progress via the Tasks/{operationToken} route.


/v1/Repositories/{repoId}/Entries/{entryId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        DeleteEntryWithAuditReason body = ; // DeleteEntryWithAuditReason | 
        try {
            AcceptedOperation result = apiInstance.delete_entry_info(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#delete_entry_info");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        DeleteEntryWithAuditReason body = ; // DeleteEntryWithAuditReason | 
        try {
            AcceptedOperation result = apiInstance.delete_entry_info(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#delete_entry_info");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.
Integer *entryId = 56; // The requested entry ID.
DeleteEntryWithAuditReason *body = ; //  (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance delete_entry_infoWith:repoId
    entryId:entryId
    body:body
              completionHandler: ^(AcceptedOperation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository ID.
var entryId = 56; // {{Integer}} The requested entry ID.
var opts = { 
  'body':  // {{DeleteEntryWithAuditReason}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delete_entry_info(repoIdentryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class delete_entry_infoExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository ID.
            var entryId = 56;  // Integer | The requested entry ID.
            var body = new DeleteEntryWithAuditReason(); // DeleteEntryWithAuditReason |  (optional) 

            try
            {
                AcceptedOperation result = apiInstance.delete_entry_info(repoId, entryId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.delete_entry_info: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository ID.
$entryId = 56; // Integer | The requested entry ID.
$body = ; // DeleteEntryWithAuditReason | 

try {
    $result = $api_instance->delete_entry_info($repoId, $entryId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->delete_entry_info: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository ID.
my $entryId = 56; # Integer | The requested entry ID.
my $body = WWW::SwaggerClient::Object::DeleteEntryWithAuditReason->new(); # DeleteEntryWithAuditReason | 

eval { 
    my $result = $api_instance->delete_entry_info(repoId => $repoId, entryId => $entryId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->delete_entry_info: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository ID.
entryId = 56 # Integer | The requested entry ID.
body =  # DeleteEntryWithAuditReason |  (optional)

try: 
    api_response = api_instance.delete_entry_info(repoId, entryId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->delete_entry_info: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required
entryId*
Integer (int32)
The requested entry ID.
Required
Body parameters
Name Description
body

Responses

Status: 201 - Delete entry operation start successfully.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 429 - Operation limit or request limit reached.


Export Document

- Get an entry's edoc resource in a stream format. - Provide an entry id, and get the edoc resource as part of the response content. - Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc.


/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/edoc

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream,application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/edoc"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The requested document id.
        String range = range_example; // String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.
        try {
            byte[] result = apiInstance.export_document(repoId, entryId, range);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#export_document");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The requested document id.
        String range = range_example; // String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.
        try {
            byte[] result = apiInstance.export_document(repoId, entryId, range);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#export_document");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository id.
Integer *entryId = 56; // The requested document id.
String *range = range_example; // An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit. (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance export_documentWith:repoId
    entryId:entryId
    range:range
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository id.
var entryId = 56; // {{Integer}} The requested document id.
var opts = { 
  'range': range_example // {{String}} An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.export_document(repoId, entryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class export_documentExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository id.
            var entryId = 56;  // Integer | The requested document id.
            var range = range_example;  // String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit. (optional) 

            try
            {
                byte[] result = apiInstance.export_document(repoId, entryId, range);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.export_document: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository id.
$entryId = 56; // Integer | The requested document id.
$range = range_example; // String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.

try {
    $result = $api_instance->export_document($repoId, $entryId, $range);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->export_document: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository id.
my $entryId = 56; # Integer | The requested document id.
my $range = range_example; # String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.

eval { 
    my $result = $api_instance->export_document(repoId => $repoId, entryId => $entryId, range => $range);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->export_document: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository id.
entryId = 56 # Integer | The requested document id.
range = range_example # String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit. (optional)

try: 
    api_response = api_instance.export_document(repoId, entryId, range=range)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->export_document: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository id.
Required
entryId*
Integer (int32)
The requested document id.
Required
Header parameters
Name Description
Range
String
An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.

Responses

Status: 200 - Get edoc successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request entry id not found.

Status: 423 - Entry is locked.

Status: 429 - Rate limit is reached.


Export Document with Audit Reason

- Get an entry's edoc resource in a stream format while including an audit reason. - Provide an entry id and audit reason/comment in the request body, and get the edoc resource as part of the response content. - Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc.


/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/GetEdocWithAuditReason

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream,application/json"\
-H "Content-Type: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/GetEdocWithAuditReason"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The requested document id.
        GetEdocWithAuditReasonRequest body = ; // GetEdocWithAuditReasonRequest | 
        String range = range_example; // String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.
        try {
            byte[] result = apiInstance.export_document_with_audit_reason(repoId, entryId, body, range);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#export_document_with_audit_reason");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The requested document id.
        GetEdocWithAuditReasonRequest body = ; // GetEdocWithAuditReasonRequest | 
        String range = range_example; // String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.
        try {
            byte[] result = apiInstance.export_document_with_audit_reason(repoId, entryId, body, range);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#export_document_with_audit_reason");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository id.
Integer *entryId = 56; // The requested document id.
GetEdocWithAuditReasonRequest *body = ; //  (optional)
String *range = range_example; // An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit. (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance export_document_with_audit_reasonWith:repoId
    entryId:entryId
    body:body
    range:range
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository id.
var entryId = 56; // {{Integer}} The requested document id.
var opts = { 
  'body':  // {{GetEdocWithAuditReasonRequest}} 
  'range': range_example // {{String}} An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.export_document_with_audit_reason(repoIdentryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class export_document_with_audit_reasonExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository id.
            var entryId = 56;  // Integer | The requested document id.
            var body = new GetEdocWithAuditReasonRequest(); // GetEdocWithAuditReasonRequest |  (optional) 
            var range = range_example;  // String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit. (optional) 

            try
            {
                byte[] result = apiInstance.export_document_with_audit_reason(repoId, entryId, body, range);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.export_document_with_audit_reason: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository id.
$entryId = 56; // Integer | The requested document id.
$body = ; // GetEdocWithAuditReasonRequest | 
$range = range_example; // String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.

try {
    $result = $api_instance->export_document_with_audit_reason($repoId, $entryId, $body, $range);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->export_document_with_audit_reason: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository id.
my $entryId = 56; # Integer | The requested document id.
my $body = WWW::SwaggerClient::Object::GetEdocWithAuditReasonRequest->new(); # GetEdocWithAuditReasonRequest | 
my $range = range_example; # String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit.

eval { 
    my $result = $api_instance->export_document_with_audit_reason(repoId => $repoId, entryId => $entryId, body => $body, range => $range);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->export_document_with_audit_reason: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository id.
entryId = 56 # Integer | The requested document id.
body =  # GetEdocWithAuditReasonRequest |  (optional)
range = range_example # String | An optional header used to retrieve partial content of the edoc. Only supports single
            range with byte unit. (optional)

try: 
    api_response = api_instance.export_document_with_audit_reason(repoId, entryId, body=body, range=range)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->export_document_with_audit_reason: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository id.
Required
entryId*
Integer (int32)
The requested document id.
Required
Header parameters
Name Description
Range
String
An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.
Body parameters
Name Description
body

Responses

Status: 200 - Get edoc successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request entry id not found.

Status: 423 - Entry is locked.

Status: 429 - Rate limit is reached.


Get Entry

- Returns a single entry object. - Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc. - Allowed OData query options: Select. If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties.


/v1/Repositories/{repoId}/Entries/{entryId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}?$select="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        String $select = $select_example; // String | Limits the properties returned in the result.
        try {
            Entry result = apiInstance.get_Entry(repoId, entryId, $select);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_Entry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        String $select = $select_example; // String | Limits the properties returned in the result.
        try {
            Entry result = apiInstance.get_Entry(repoId, entryId, $select);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_Entry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.
Integer *entryId = 56; // The requested entry ID.
String *$select = $select_example; // Limits the properties returned in the result. (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance get_EntryWith:repoId
    entryId:entryId
    $select:$select
              completionHandler: ^(Entry output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository ID.
var entryId = 56; // {{Integer}} The requested entry ID.
var opts = { 
  '$select': $select_example // {{String}} Limits the properties returned in the result.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_Entry(repoId, entryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class get_EntryExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository ID.
            var entryId = 56;  // Integer | The requested entry ID.
            var $select = $select_example;  // String | Limits the properties returned in the result. (optional) 

            try
            {
                Entry result = apiInstance.get_Entry(repoId, entryId, $select);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.get_Entry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository ID.
$entryId = 56; // Integer | The requested entry ID.
$$select = $select_example; // String | Limits the properties returned in the result.

try {
    $result = $api_instance->get_Entry($repoId, $entryId, $$select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->get_Entry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository ID.
my $entryId = 56; # Integer | The requested entry ID.
my $$select = $select_example; # String | Limits the properties returned in the result.

eval { 
    my $result = $api_instance->get_Entry(repoId => $repoId, entryId => $entryId, $select => $$select);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->get_Entry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository ID.
entryId = 56 # Integer | The requested entry ID.
$select = $select_example # String | Limits the properties returned in the result. (optional)

try: 
    api_response = api_instance.get_entry(repoId, entryId, $select=$select)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_Entry: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required
entryId*
Integer (int32)
The requested entry ID.
Required
Query parameters
Name Description
$select
String
Limits the properties returned in the result.

Responses

Status: 200 - Get entry successfully.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Requested entry id not found.

Status: 429 - Rate limit is reached.


Get Entry Listing

- Returns the children entries of a folder in the repository. - Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository. - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". Sort order can be either value "asc" or "desc". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route.


/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Folder/children

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Folder/children?groupByEntryType=&$select=&$orderby=&$top=&$skip=&$count="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The folder ID.
        Boolean groupByEntryType = true; // Boolean | An optional query parameter used to indicate if the result should be grouped by entry type or not.
        String prefer = prefer_example; // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
        String $select = $select_example; // String | Limits the properties returned in the result.
        String $orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
        Integer $top = 56; // Integer | Limits the number of items returned from a collection.
        Integer $skip = 56; // Integer | Excludes the specified number of items of the queried collection from the result.
        Boolean $count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.
        try {
            ODataValueOfIListOfEntry result = apiInstance.get_Entry_Listing(repoId, entryId, groupByEntryType, prefer, $select, $orderby, $top, $skip, $count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_Entry_Listing");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The folder ID.
        Boolean groupByEntryType = true; // Boolean | An optional query parameter used to indicate if the result should be grouped by entry type or not.
        String prefer = prefer_example; // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
        String $select = $select_example; // String | Limits the properties returned in the result.
        String $orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
        Integer $top = 56; // Integer | Limits the number of items returned from a collection.
        Integer $skip = 56; // Integer | Excludes the specified number of items of the queried collection from the result.
        Boolean $count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.
        try {
            ODataValueOfIListOfEntry result = apiInstance.get_Entry_Listing(repoId, entryId, groupByEntryType, prefer, $select, $orderby, $top, $skip, $count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_Entry_Listing");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.
Integer *entryId = 56; // The folder ID.
Boolean *groupByEntryType = true; // An optional query parameter used to indicate if the result should be grouped by entry type or not. (optional)
String *prefer = prefer_example; // An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional)
String *$select = $select_example; // Limits the properties returned in the result. (optional)
String *$orderby = $orderby_example; // Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
Integer *$top = 56; // Limits the number of items returned from a collection. (optional)
Integer *$skip = 56; // Excludes the specified number of items of the queried collection from the result. (optional)
Boolean *$count = true; // Indicates whether the total count of items within a collection are returned in the result. (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance get_Entry_ListingWith:repoId
    entryId:entryId
    groupByEntryType:groupByEntryType
    prefer:prefer
    $select:$select
    $orderby:$orderby
    $top:$top
    $skip:$skip
    $count:$count
              completionHandler: ^(ODataValueOfIListOfEntry output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository ID.
var entryId = 56; // {{Integer}} The folder ID.
var opts = { 
  'groupByEntryType': true, // {{Boolean}} An optional query parameter used to indicate if the result should be grouped by entry type or not.
  'prefer': prefer_example, // {{String}} An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
  '$select': $select_example, // {{String}} Limits the properties returned in the result.
  '$orderby': $orderby_example, // {{String}} Specifies the order in which items are returned. The maximum number of expressions is 5.
  '$top': 56, // {{Integer}} Limits the number of items returned from a collection.
  '$skip': 56, // {{Integer}} Excludes the specified number of items of the queried collection from the result.
  '$count': true // {{Boolean}} Indicates whether the total count of items within a collection are returned in the result.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_Entry_Listing(repoId, entryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class get_Entry_ListingExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository ID.
            var entryId = 56;  // Integer | The folder ID.
            var groupByEntryType = true;  // Boolean | An optional query parameter used to indicate if the result should be grouped by entry type or not. (optional) 
            var prefer = prefer_example;  // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional) 
            var $select = $select_example;  // String | Limits the properties returned in the result. (optional) 
            var $orderby = $orderby_example;  // String | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional) 
            var $top = 56;  // Integer | Limits the number of items returned from a collection. (optional) 
            var $skip = 56;  // Integer | Excludes the specified number of items of the queried collection from the result. (optional) 
            var $count = true;  // Boolean | Indicates whether the total count of items within a collection are returned in the result. (optional) 

            try
            {
                ODataValueOfIListOfEntry result = apiInstance.get_Entry_Listing(repoId, entryId, groupByEntryType, prefer, $select, $orderby, $top, $skip, $count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.get_Entry_Listing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository ID.
$entryId = 56; // Integer | The folder ID.
$groupByEntryType = true; // Boolean | An optional query parameter used to indicate if the result should be grouped by entry type or not.
$prefer = prefer_example; // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
$$select = $select_example; // String | Limits the properties returned in the result.
$$orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
$$top = 56; // Integer | Limits the number of items returned from a collection.
$$skip = 56; // Integer | Excludes the specified number of items of the queried collection from the result.
$$count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.

try {
    $result = $api_instance->get_Entry_Listing($repoId, $entryId, $groupByEntryType, $prefer, $$select, $$orderby, $$top, $$skip, $$count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->get_Entry_Listing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository ID.
my $entryId = 56; # Integer | The folder ID.
my $groupByEntryType = true; # Boolean | An optional query parameter used to indicate if the result should be grouped by entry type or not.
my $prefer = prefer_example; # String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
my $$select = $select_example; # String | Limits the properties returned in the result.
my $$orderby = $orderby_example; # String | Specifies the order in which items are returned. The maximum number of expressions is 5.
my $$top = 56; # Integer | Limits the number of items returned from a collection.
my $$skip = 56; # Integer | Excludes the specified number of items of the queried collection from the result.
my $$count = true; # Boolean | Indicates whether the total count of items within a collection are returned in the result.

eval { 
    my $result = $api_instance->get_Entry_Listing(repoId => $repoId, entryId => $entryId, groupByEntryType => $groupByEntryType, prefer => $prefer, $select => $$select, $orderby => $$orderby, $top => $$top, $skip => $$skip, $count => $$count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->get_Entry_Listing: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository ID.
entryId = 56 # Integer | The folder ID.
groupByEntryType = true # Boolean | An optional query parameter used to indicate if the result should be grouped by entry type or not. (optional)
prefer = prefer_example # String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional)
$select = $select_example # String | Limits the properties returned in the result. (optional)
$orderby = $orderby_example # String | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
$top = 56 # Integer | Limits the number of items returned from a collection. (optional)
$skip = 56 # Integer | Excludes the specified number of items of the queried collection from the result. (optional)
$count = true # Boolean | Indicates whether the total count of items within a collection are returned in the result. (optional)

try: 
    api_response = api_instance.get_entry_listing(repoId, entryId, groupByEntryType=groupByEntryType, prefer=prefer, $select=$select, $orderby=$orderby, $top=$top, $skip=$skip, $count=$count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_Entry_Listing: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required
entryId*
Integer (int32)
The folder ID.
Required
Header parameters
Name Description
Prefer
String
An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
Query parameters
Name Description
groupByEntryType
Boolean
An optional query parameter used to indicate if the result should be grouped by entry type or not.
$select
String
Limits the properties returned in the result.
$orderby
String
Specifies the order in which items are returned. The maximum number of expressions is 5.
$top
Integer (int32)
Limits the number of items returned from a collection.
$skip
Integer (int32)
Excludes the specified number of items of the queried collection from the result.
$count
Boolean
Indicates whether the total count of items within a collection are returned in the result.

Responses

Status: 200 - Get the children entries of a Folder successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request entry id not found.

Status: 429 - Rate limit is reached.


Get Field Values

- Returns the fields assigned to an entry. - Provide an entry ID, and get a paged listing of all fields assigned to that entry. - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.


/v1/Repositories/{repoId}/Entries/{entryId}/fields

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/fields?formatValue=&culture=&$select=&$orderby=&$top=&$skip=&$count="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        String prefer = prefer_example; // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
        Boolean formatValue = true; // Boolean | An optional query parameter used to indicate if the field values should be formatted.
            The default value is false.
        String culture = culture_example; // String | An optional query parameter used to indicate the locale that should be used for formatting.
            The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
            culture will not be used for formatting.
        String $select = $select_example; // String | Limits the properties returned in the result.
        String $orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
        Integer $top = 56; // Integer | Limits the number of items returned from a collection.
        Integer $skip = 56; // Integer | Excludes the specified number of items of the queried collection from the result.
        Boolean $count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.
        try {
            ODataValueOfIListOfFieldValue result = apiInstance.get_Field_Values(repoId, entryId, prefer, formatValue, culture, $select, $orderby, $top, $skip, $count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_Field_Values");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        String prefer = prefer_example; // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
        Boolean formatValue = true; // Boolean | An optional query parameter used to indicate if the field values should be formatted.
            The default value is false.
        String culture = culture_example; // String | An optional query parameter used to indicate the locale that should be used for formatting.
            The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
            culture will not be used for formatting.
        String $select = $select_example; // String | Limits the properties returned in the result.
        String $orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
        Integer $top = 56; // Integer | Limits the number of items returned from a collection.
        Integer $skip = 56; // Integer | Excludes the specified number of items of the queried collection from the result.
        Boolean $count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.
        try {
            ODataValueOfIListOfFieldValue result = apiInstance.get_Field_Values(repoId, entryId, prefer, formatValue, culture, $select, $orderby, $top, $skip, $count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_Field_Values");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.
Integer *entryId = 56; // The requested entry ID.
String *prefer = prefer_example; // An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional)
Boolean *formatValue = true; // An optional query parameter used to indicate if the field values should be formatted.
            The default value is false. (optional) (default to false)
String *culture = culture_example; // An optional query parameter used to indicate the locale that should be used for formatting.
            The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
            culture will not be used for formatting. (optional)
String *$select = $select_example; // Limits the properties returned in the result. (optional)
String *$orderby = $orderby_example; // Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
Integer *$top = 56; // Limits the number of items returned from a collection. (optional)
Integer *$skip = 56; // Excludes the specified number of items of the queried collection from the result. (optional)
Boolean *$count = true; // Indicates whether the total count of items within a collection are returned in the result. (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance get_Field_ValuesWith:repoId
    entryId:entryId
    prefer:prefer
    formatValue:formatValue
    culture:culture
    $select:$select
    $orderby:$orderby
    $top:$top
    $skip:$skip
    $count:$count
              completionHandler: ^(ODataValueOfIListOfFieldValue output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository ID.
var entryId = 56; // {{Integer}} The requested entry ID.
var opts = { 
  'prefer': prefer_example, // {{String}} An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
  'formatValue': true, // {{Boolean}} An optional query parameter used to indicate if the field values should be formatted.
            The default value is false.
  'culture': culture_example, // {{String}} An optional query parameter used to indicate the locale that should be used for formatting.
            The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
            culture will not be used for formatting.
  '$select': $select_example, // {{String}} Limits the properties returned in the result.
  '$orderby': $orderby_example, // {{String}} Specifies the order in which items are returned. The maximum number of expressions is 5.
  '$top': 56, // {{Integer}} Limits the number of items returned from a collection.
  '$skip': 56, // {{Integer}} Excludes the specified number of items of the queried collection from the result.
  '$count': true // {{Boolean}} Indicates whether the total count of items within a collection are returned in the result.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_Field_Values(repoId, entryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class get_Field_ValuesExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository ID.
            var entryId = 56;  // Integer | The requested entry ID.
            var prefer = prefer_example;  // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional) 
            var formatValue = true;  // Boolean | An optional query parameter used to indicate if the field values should be formatted.
            The default value is false. (optional)  (default to false)
            var culture = culture_example;  // String | An optional query parameter used to indicate the locale that should be used for formatting.
            The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
            culture will not be used for formatting. (optional) 
            var $select = $select_example;  // String | Limits the properties returned in the result. (optional) 
            var $orderby = $orderby_example;  // String | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional) 
            var $top = 56;  // Integer | Limits the number of items returned from a collection. (optional) 
            var $skip = 56;  // Integer | Excludes the specified number of items of the queried collection from the result. (optional) 
            var $count = true;  // Boolean | Indicates whether the total count of items within a collection are returned in the result. (optional) 

            try
            {
                ODataValueOfIListOfFieldValue result = apiInstance.get_Field_Values(repoId, entryId, prefer, formatValue, culture, $select, $orderby, $top, $skip, $count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.get_Field_Values: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository ID.
$entryId = 56; // Integer | The requested entry ID.
$prefer = prefer_example; // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
$formatValue = true; // Boolean | An optional query parameter used to indicate if the field values should be formatted.
            The default value is false.
$culture = culture_example; // String | An optional query parameter used to indicate the locale that should be used for formatting.
            The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
            culture will not be used for formatting.
$$select = $select_example; // String | Limits the properties returned in the result.
$$orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
$$top = 56; // Integer | Limits the number of items returned from a collection.
$$skip = 56; // Integer | Excludes the specified number of items of the queried collection from the result.
$$count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.

try {
    $result = $api_instance->get_Field_Values($repoId, $entryId, $prefer, $formatValue, $culture, $$select, $$orderby, $$top, $$skip, $$count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->get_Field_Values: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository ID.
my $entryId = 56; # Integer | The requested entry ID.
my $prefer = prefer_example; # String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
my $formatValue = true; # Boolean | An optional query parameter used to indicate if the field values should be formatted.
            The default value is false.
my $culture = culture_example; # String | An optional query parameter used to indicate the locale that should be used for formatting.
            The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
            culture will not be used for formatting.
my $$select = $select_example; # String | Limits the properties returned in the result.
my $$orderby = $orderby_example; # String | Specifies the order in which items are returned. The maximum number of expressions is 5.
my $$top = 56; # Integer | Limits the number of items returned from a collection.
my $$skip = 56; # Integer | Excludes the specified number of items of the queried collection from the result.
my $$count = true; # Boolean | Indicates whether the total count of items within a collection are returned in the result.

eval { 
    my $result = $api_instance->get_Field_Values(repoId => $repoId, entryId => $entryId, prefer => $prefer, formatValue => $formatValue, culture => $culture, $select => $$select, $orderby => $$orderby, $top => $$top, $skip => $$skip, $count => $$count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->get_Field_Values: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository ID.
entryId = 56 # Integer | The requested entry ID.
prefer = prefer_example # String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional)
formatValue = true # Boolean | An optional query parameter used to indicate if the field values should be formatted.
            The default value is false. (optional) (default to false)
culture = culture_example # String | An optional query parameter used to indicate the locale that should be used for formatting.
            The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
            culture will not be used for formatting. (optional)
$select = $select_example # String | Limits the properties returned in the result. (optional)
$orderby = $orderby_example # String | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
$top = 56 # Integer | Limits the number of items returned from a collection. (optional)
$skip = 56 # Integer | Excludes the specified number of items of the queried collection from the result. (optional)
$count = true # Boolean | Indicates whether the total count of items within a collection are returned in the result. (optional)

try: 
    api_response = api_instance.get_field_values(repoId, entryId, prefer=prefer, formatValue=formatValue, culture=culture, $select=$select, $orderby=$orderby, $top=$top, $skip=$skip, $count=$count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_Field_Values: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required
entryId*
Integer (int32)
The requested entry ID.
Required
Header parameters
Name Description
Prefer
String
An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
Query parameters
Name Description
formatValue
Boolean
An optional query parameter used to indicate if the field values should be formatted. The default value is false.
culture
String
An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting.
$select
String
Limits the properties returned in the result.
$orderby
String
Specifies the order in which items are returned. The maximum number of expressions is 5.
$top
Integer (int32)
Limits the number of items returned from a collection.
$skip
Integer (int32)
Excludes the specified number of items of the queried collection from the result.
$count
Boolean
Indicates whether the total count of items within a collection are returned in the result.

Responses

Status: 200 - Get field values successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request entry id not found.

Status: 429 - Rate limit is reached.


Get Tags Assigned to Entry

- Get the tags assigned to an entry. - Provide an entry ID, and get a paged listing of tags assigned to that entry. - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.


/v1/Repositories/{repoId}/Entries/{entryId}/tags

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/tags?$select=&$orderby=&$top=&$skip=&$count="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        String prefer = prefer_example; // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
        String $select = $select_example; // String | Limits the properties returned in the result.
        String $orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
        Integer $top = 56; // Integer | Limits the number of items returned from a collection.
        Integer $skip = 56; // Integer | Excludes the specified number of items of the queried collection from the result.
        Boolean $count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.
        try {
            ODataValueOfIListOfWTagInfo result = apiInstance.get_Tags_Assigned_to_Entry(repoId, entryId, prefer, $select, $orderby, $top, $skip, $count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_Tags_Assigned_to_Entry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository ID.
        Integer entryId = 56; // Integer | The requested entry ID.
        String prefer = prefer_example; // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
        String $select = $select_example; // String | Limits the properties returned in the result.
        String $orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
        Integer $top = 56; // Integer | Limits the number of items returned from a collection.
        Integer $skip = 56; // Integer | Excludes the specified number of items of the queried collection from the result.
        Boolean $count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.
        try {
            ODataValueOfIListOfWTagInfo result = apiInstance.get_Tags_Assigned_to_Entry(repoId, entryId, prefer, $select, $orderby, $top, $skip, $count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_Tags_Assigned_to_Entry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository ID.
Integer *entryId = 56; // The requested entry ID.
String *prefer = prefer_example; // An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional)
String *$select = $select_example; // Limits the properties returned in the result. (optional)
String *$orderby = $orderby_example; // Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
Integer *$top = 56; // Limits the number of items returned from a collection. (optional)
Integer *$skip = 56; // Excludes the specified number of items of the queried collection from the result. (optional)
Boolean *$count = true; // Indicates whether the total count of items within a collection are returned in the result. (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance get_Tags_Assigned_to_EntryWith:repoId
    entryId:entryId
    prefer:prefer
    $select:$select
    $orderby:$orderby
    $top:$top
    $skip:$skip
    $count:$count
              completionHandler: ^(ODataValueOfIListOfWTagInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository ID.
var entryId = 56; // {{Integer}} The requested entry ID.
var opts = { 
  'prefer': prefer_example, // {{String}} An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
  '$select': $select_example, // {{String}} Limits the properties returned in the result.
  '$orderby': $orderby_example, // {{String}} Specifies the order in which items are returned. The maximum number of expressions is 5.
  '$top': 56, // {{Integer}} Limits the number of items returned from a collection.
  '$skip': 56, // {{Integer}} Excludes the specified number of items of the queried collection from the result.
  '$count': true // {{Boolean}} Indicates whether the total count of items within a collection are returned in the result.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_Tags_Assigned_to_Entry(repoId, entryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class get_Tags_Assigned_to_EntryExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository ID.
            var entryId = 56;  // Integer | The requested entry ID.
            var prefer = prefer_example;  // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional) 
            var $select = $select_example;  // String | Limits the properties returned in the result. (optional) 
            var $orderby = $orderby_example;  // String | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional) 
            var $top = 56;  // Integer | Limits the number of items returned from a collection. (optional) 
            var $skip = 56;  // Integer | Excludes the specified number of items of the queried collection from the result. (optional) 
            var $count = true;  // Boolean | Indicates whether the total count of items within a collection are returned in the result. (optional) 

            try
            {
                ODataValueOfIListOfWTagInfo result = apiInstance.get_Tags_Assigned_to_Entry(repoId, entryId, prefer, $select, $orderby, $top, $skip, $count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.get_Tags_Assigned_to_Entry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository ID.
$entryId = 56; // Integer | The requested entry ID.
$prefer = prefer_example; // String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
$$select = $select_example; // String | Limits the properties returned in the result.
$$orderby = $orderby_example; // String | Specifies the order in which items are returned. The maximum number of expressions is 5.
$$top = 56; // Integer | Limits the number of items returned from a collection.
$$skip = 56; // Integer | Excludes the specified number of items of the queried collection from the result.
$$count = true; // Boolean | Indicates whether the total count of items within a collection are returned in the result.

try {
    $result = $api_instance->get_Tags_Assigned_to_Entry($repoId, $entryId, $prefer, $$select, $$orderby, $$top, $$skip, $$count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->get_Tags_Assigned_to_Entry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository ID.
my $entryId = 56; # Integer | The requested entry ID.
my $prefer = prefer_example; # String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
my $$select = $select_example; # String | Limits the properties returned in the result.
my $$orderby = $orderby_example; # String | Specifies the order in which items are returned. The maximum number of expressions is 5.
my $$top = 56; # Integer | Limits the number of items returned from a collection.
my $$skip = 56; # Integer | Excludes the specified number of items of the queried collection from the result.
my $$count = true; # Boolean | Indicates whether the total count of items within a collection are returned in the result.

eval { 
    my $result = $api_instance->get_Tags_Assigned_to_Entry(repoId => $repoId, entryId => $entryId, prefer => $prefer, $select => $$select, $orderby => $$orderby, $top => $$top, $skip => $$skip, $count => $$count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->get_Tags_Assigned_to_Entry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository ID.
entryId = 56 # Integer | The requested entry ID.
prefer = prefer_example # String | An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. (optional)
$select = $select_example # String | Limits the properties returned in the result. (optional)
$orderby = $orderby_example # String | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
$top = 56 # Integer | Limits the number of items returned from a collection. (optional)
$skip = 56 # Integer | Excludes the specified number of items of the queried collection from the result. (optional)
$count = true # Boolean | Indicates whether the total count of items within a collection are returned in the result. (optional)

try: 
    api_response = api_instance.get_tags_assigned_to_entry(repoId, entryId, prefer=prefer, $select=$select, $orderby=$orderby, $top=$top, $skip=$skip, $count=$count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_Tags_Assigned_to_Entry: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository ID.
Required
entryId*
Integer (int32)
The requested entry ID.
Required
Header parameters
Name Description
Prefer
String
An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
Query parameters
Name Description
$select
String
Limits the properties returned in the result.
$orderby
String
Specifies the order in which items are returned. The maximum number of expressions is 5.
$top
Integer (int32)
Limits the number of items returned from a collection.
$skip
Integer (int32)
Excludes the specified number of items of the queried collection from the result.
$count
Boolean
Indicates whether the total count of items within a collection are returned in the result.

Responses

Status: 200 - Get entry tags successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request entry id not found.

Status: 429 - Rate limit is reached.


Get Document Content Type

- Get information about the edoc content of an entry, without downloading the edoc in its entirety. - Provide an entry id, and get back the Content-Type and Content-Length in the response headers. - This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry.


/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/edoc

Usage and SDK Samples

curl -X HEAD\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/Laserfiche.Repository.Document/edoc"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The requested document id.
        try {
            apiInstance.get_document_content_type(repoId, entryId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_document_content_type");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The requested document id.
        try {
            apiInstance.get_document_content_type(repoId, entryId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_document_content_type");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository id.
Integer *entryId = 56; // The requested document id.

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance get_document_content_typeWith:repoId
    entryId:entryId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository id.
var entryId = 56; // {{Integer}} The requested document id.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.get_document_content_type(repoId, entryId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class get_document_content_typeExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository id.
            var entryId = 56;  // Integer | The requested document id.

            try
            {
                apiInstance.get_document_content_type(repoId, entryId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.get_document_content_type: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository id.
$entryId = 56; // Integer | The requested document id.

try {
    $api_instance->get_document_content_type($repoId, $entryId);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->get_document_content_type: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository id.
my $entryId = 56; # Integer | The requested document id.

eval { 
    $api_instance->get_document_content_type(repoId => $repoId, entryId => $entryId);
};
if ($@) {
    warn "Exception when calling EntriesApi->get_document_content_type: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository id.
entryId = 56 # Integer | The requested document id.

try: 
    api_instance.get_document_content_type(repoId, entryId)
except ApiException as e:
    print("Exception when calling EntriesApi->get_document_content_type: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository id.
Required
entryId*
Integer (int32)
The requested document id.
Required

Responses

Status: 200 - Get edoc info successfully.

Status: 401 - Access token is invalid or expired.

Status: 403 - Access denied for the operation.

Status: 404 - Request entry id not found.

Status: 423 - Entry is locked.

Status: 429 - Rate limit is reached.


Get Dynamic Field Values

- Get dynamic field logic values with the current values of the fields in the template. - Provide an entry id and field values in the JSON body to get dynamic field logic values. Independent and non-dynamic fields in the request body will be ignored, and only related dynamic field logic values for the assigned template will be returned.


/v1/Repositories/{repoId}/Entries/{entryId}/fields/GetDynamicFieldLogicValue

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.laserfiche.com/repository/v1/Repositories/{repoId}/Entries/{entryId}/fields/GetDynamicFieldLogicValue"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EntriesApi;

import java.io.File;
import java.util.*;

public class EntriesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The requested entry id.
        GetDynamicFieldLogicValueRequest body = ; // GetDynamicFieldLogicValueRequest | 
        try {
            map['String', array['String']] result = apiInstance.get_dynamic_field_values(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_dynamic_field_values");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EntriesApi;

public class EntriesApiExample {

    public static void main(String[] args) {
        EntriesApi apiInstance = new EntriesApi();
        String repoId = repoId_example; // String | The requested repository id.
        Integer entryId = 56; // Integer | The requested entry id.
        GetDynamicFieldLogicValueRequest body = ; // GetDynamicFieldLogicValueRequest | 
        try {
            map['String', array['String']] result = apiInstance.get_dynamic_field_values(repoId, entryId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntriesApi#get_dynamic_field_values");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *repoId = repoId_example; // The requested repository id.
Integer *entryId = 56; // The requested entry id.
GetDynamicFieldLogicValueRequest *body = ; //  (optional)

EntriesApi *apiInstance = [[EntriesApi alloc] init];

[apiInstance get_dynamic_field_valuesWith:repoId
    entryId:entryId
    body:body
              completionHandler: ^(map['String', array['String']] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LaserficheApi = require('laserfiche_api');
var defaultClient = LaserficheApi.ApiClient.instance;


var api = new LaserficheApi.EntriesApi()
var repoId = repoId_example; // {{String}} The requested repository id.
var entryId = 56; // {{Integer}} The requested entry id.
var opts = { 
  'body':  // {{GetDynamicFieldLogicValueRequest}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_dynamic_field_values(repoIdentryId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class get_dynamic_field_valuesExample
    {
        public void main()
        {


            var apiInstance = new EntriesApi();
            var repoId = repoId_example;  // String | The requested repository id.
            var entryId = 56;  // Integer | The requested entry id.
            var body = new GetDynamicFieldLogicValueRequest(); // GetDynamicFieldLogicValueRequest |  (optional) 

            try
            {
                map['String', array['String']] result = apiInstance.get_dynamic_field_values(repoId, entryId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EntriesApi.get_dynamic_field_values: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEntriesApi();
$repoId = repoId_example; // String | The requested repository id.
$entryId = 56; // Integer | The requested entry id.
$body = ; // GetDynamicFieldLogicValueRequest | 

try {
    $result = $api_instance->get_dynamic_field_values($repoId, $entryId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntriesApi->get_dynamic_field_values: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EntriesApi;


my $api_instance = WWW::SwaggerClient::EntriesApi->new();
my $repoId = repoId_example; # String | The requested repository id.
my $entryId = 56; # Integer | The requested entry id.
my $body = WWW::SwaggerClient::Object::GetDynamicFieldLogicValueRequest->new(); # GetDynamicFieldLogicValueRequest | 

eval { 
    my $result = $api_instance->get_dynamic_field_values(repoId => $repoId, entryId => $entryId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntriesApi->get_dynamic_field_values: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.EntriesApi()
repoId = repoId_example # String | The requested repository id.
entryId = 56 # Integer | The requested entry id.
body =  # GetDynamicFieldLogicValueRequest |  (optional)

try: 
    api_response = api_instance.get_dynamic_field_values(repoId, entryId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntriesApi->get_dynamic_field_values: %s\n" % e)

Parameters

Path parameters
Name Description
repoId*
String
The requested repository id.
Required
entryId*
Integer (int32)
The requested entry id.
Required
Body parameters
Name Description
body

Responses

Status: 200 - Get dynamic field logic values successfully.

Status: 400 - Invalid or bad request.

Status: 401 - Access token is invalid or expired.

Status: 404 - Request entry not found.

Status: 429 - Rate limit is reached.