REST-API

This page describes the REST-API of the edu-sharing RC1 of version 3.1

edu-sharing Repository REST API (for version 3.1 RC1)

The public restful API of the edu-sharing repository.
More information: https://edu-sharing.com
Contact Info: info@edu-sharing.com
Version: 1.0

on this page:

Access

The edu-sharing REST-API provides OAuth2 authentication.
The following chapter describes the steps necessary to access this API.

Prerequisites

Your application must be registered as a trusted client for the serving edu-sharing repository in
./tomcat/webapps/edu-sharing/WEB-INF/classes/org/edu_sharing/spring/authentication-services.xml:

<bean id="oauthTokenService" class="org.edu_sharing.service.authentication.oauth2.TokenService" init-method="init">
   <property name="expiresIn">
       <value>3600</value>
    </property>
   <property name="trustedClients">
      <map>
         <entry key="yourApp" value="yourSecret" />
      </map>
    </property>
 </bean>

 

To get an access token you will need the "secret" later.
"expiresIn" lets you define the timeframe during which the token will be considered as valid.

Obtaining an access token

Call "http://example.com/edu-sharing/oauth2/token" with the following parameters to obtain a token

grant_type = password
client_id = yourApp
client_secret = yourSecret
username = <user>
password = <password>
curl -v -X POST -d 'grant_type=password&client_id=eduApp&client_secret=secret&username=<user>&password=<password>' 'http://example.com/edu-sharing/oauth2/token'


If successful (HTTP status code 200, 401 otherwise) the response body will contain

access_token - the desired token
refresh_token - a token to obtain a new access token (see below)
expires_in - timeframe (in seconds) during which the token will be considered as valid by the API server

If time runs up for your access token (limited by "expires_in") you can fetch new access and refresh tokens via

curl -v -X POST -d 'grant_type=refresh_token&client_id=eduApp&client_secret=secret&refresh_token=<refresh_token>' 'http://example.com/edu-sharing/oauth2/token'

Keep in mind: Every refresh token can only be used once.

Using an access token

For every API request you have to set an authorization header, so that the API server can decide whether to handle a request or not.
The header used for OAuth2 is "Authorization: Bearer <access_token>"

The full request would look like

curl -v -X GET -c cookie --header 'Authorization: Bearer <access_token>' --header 'Accept: application/json' 'http://example.com/edu-sharing/rest/_about'

Code Examples

Check out the following links for some basic API client example implementations 

PHP Client Example

Angular2 Client Example

Python Client Example

Methods

 

get /_about

Discover the API. ( about)
Get all services provided by this API.

Return type

Example data

Content-Type: application/json
        {
  "services" : [ {
    "instances" : [ {
      "endpoint" : "aeiou",
      "version" : ""
    } ],
    "name" : "aeiou"
  } ],
  "version" : {
    "major" : 123,
    "minor" : 123
  }
}
      

Responses

200

OK. About

401

Authorization failed. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

put /iam/v1/groups/{repository}/{group}/members/{member}

Add member to the group. ( addMembership)
Add member to the group. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
group (required)
Path Parameter — groupname
member (required)
Path Parameter — authorityName of member

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

put /iam/v1/groups/{repository}/{group}/profile

Set profile of the group. ( changeGroupProfile)
Set profile of the group. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
group (required)
Path Parameter — groupname

Request body

body (required)
Body Parameter — properties

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

put /iam/v1/people/{repository}/{person}/credential

Change/Set password of the user. ( changeUserPassword)
Change/Set password of the user. (To change foreign passwords or set passwords, admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
person (required)
Path Parameter — username (or \"-me-\" for current user)

Request body

body (required)
Body Parameter — credential

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

put /iam/v1/people/{repository}/{person}/profile

Set profile of the user. ( changeUserProfile)
Set profile of the user. (To set foreign profiles, admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
person (required)
Path Parameter — username (or \"-me-\" for current user)

Request body

body (required)
Body Parameter — properties

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

post /iam/v1/groups/{repository}/{group}

Create a new group. ( createGroup)
Create a new group. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
group (required)
Path Parameter — groupname

Request body

body (required)
Body Parameter — properties

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

post /iam/v1/people/{repository}/{person}

Create a new user. ( createUser)
Create a new user. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
person (required)
Path Parameter — username

Request body

body (required)
Body Parameter — profile

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

delete /iam/v1/groups/{repository}/{group}

Delete the group. ( deleteGroup)
Delete the group. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
group (required)
Path Parameter — groupname

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

delete /iam/v1/groups/{repository}/{group}/members/{member}

Delete member from the group. ( deleteMembership)
Delete member from the group. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
group (required)
Path Parameter — groupname
member (required)
Path Parameter — authorityName of member

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

delete /iam/v1/people/{repository}/{person}

Delete the user. ( deleteUser)
Delete the user. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
person (required)
Path Parameter — username

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /iam/v1/groups/{repository}/{group}

Get the group. ( getGroup)
Get the group. (To get foreign profiles, admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
group (required)
Path Parameter — groupname

Return type

Example data

Content-Type: application/json
        {
  "group" : {
    "groupName" : "aeiou",
    "authorityName" : "aeiou",
    "profile" : {
      "displayName" : "aeiou"
    },
    "authorityType" : "aeiou"
  }
}
      

Responses

200

OK. GroupEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /iam/v1/groups/{repository}/{group}/members

Get all members of the group. ( getMembership)
Get all members of the group. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
group (required)
Path Parameter — groupname

Return type

Example data

Content-Type: application/json
        {
  "authorities" : [ {
    "authorityName" : "aeiou",
    "authorityType" : "aeiou"
  } ]
}
      

Responses

200

OK. AuthorityEntries

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /iam/v1/people/{repository}/{person}

Get the user. ( getUser)
Get the user. (To get foreign profiles, admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
person (required)
Path Parameter — username (or \"-me-\" for current user)

Return type

Example data

Content-Type: application/json
        {
  "person" : {
    "authorityName" : "aeiou",
    "homeFolder" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "profile" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "email" : "aeiou"
    },
    "sharedFolders" : [ "" ],
    "userName" : "aeiou",
    "authorityType" : "aeiou"
  }
}
      

Responses

200

OK. UserEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /iam/v1/groups/{repository}

Search groups. ( searchGroup)
Search groups. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)

Query parameters

pattern (required)
Query Parameter — pattern

Return type

Example data

Content-Type: application/json
        {
  "groups" : [ {
    "groupName" : "aeiou",
    "authorityName" : "aeiou",
    "profile" : {
      "displayName" : "aeiou"
    },
    "authorityType" : "aeiou"
  } ]
}
      

Responses

200

OK. GroupEntries

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /iam/v1/people/{repository}

Search users. ( searchUser)
Search users. (admin rights are required.)

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)

Query parameters

pattern (required)
Query Parameter — pattern

Return type

Example data

Content-Type: application/json
        {
  "users" : [ {
    "authorityName" : "aeiou",
    "homeFolder" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "profile" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "email" : "aeiou"
    },
    "sharedFolders" : [ "" ],
    "userName" : "aeiou",
    "authorityType" : "aeiou"
  } ]
}
      

Responses

200

OK. UserEntries

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /mds/v1/metadatasets/{repository}/{metadataset}

Get metadata set. ( getMetadataSet)
Get metadata set.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
metadataset (required)
Path Parameter — ID of metadataset (or \"-default-\" for default metadata set)

Return type

Example data

Content-Type: application/json
        {
  "mds" : {
    "types" : [ {
      "type" : "aeiou",
      "properties" : [ {
        "defaultValue" : "aeiou",
        "name" : "aeiou",
        "multiple" : true,
        "processtype" : "aeiou",
        "type" : "aeiou",
        "keyContenturl" : "aeiou",
        "concatewithtype" : true,
        "copyFrom" : "aeiou"
      } ]
    } ],
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "lists" : [ {
      "id" : "aeiou",
      "label" : "aeiou",
      "properties" : [ {
        "widget" : "aeiou",
        "formLength" : "aeiou",
        "values" : [ {
          "value" : "aeiou",
          "key" : "aeiou"
        } ],
        "multiple" : true,
        "label" : "aeiou",
        "styleName" : "aeiou",
        "type" : "aeiou",
        "styleNameLabel" : "aeiou",
        "copyFrom" : [ "aeiou" ],
        "widgetTitle" : "aeiou",
        "formHeight" : "aeiou",
        "name" : "aeiou",
        "defaultValues" : [ "aeiou" ],
        "labelHint" : "aeiou",
        "parameters" : [ {
          "name" : "aeiou",
          "value" : "aeiou"
        } ],
        "placeHolder" : "aeiou"
      } ]
    } ],
    "queries" : {
      "baseQuery" : "aeiou",
      "queries" : [ {
        "layout" : "aeiou",
        "handlerclass" : "aeiou",
        "widget" : "aeiou",
        "criteriaboxid" : "aeiou",
        "statement" : "aeiou",
        "stylename" : "aeiou",
        "join" : "aeiou",
        "label" : "aeiou",
        "properties" : [ {
          "multipleJoin" : "aeiou",
          "widget" : "aeiou",
          "initByGetParam" : "aeiou",
          "formLength" : "aeiou",
          "validators" : [ "aeiou" ],
          "values" : [ {
            "value" : "aeiou",
            "key" : "aeiou"
          } ],
          "multiple" : true,
          "label" : "aeiou",
          "styleName" : "aeiou",
          "type" : "aeiou",
          "styleNameLabel" : "aeiou",
          "copyFrom" : [ "aeiou" ],
          "toogle" : true,
          "widgetTitle" : "aeiou",
          "formHeight" : "aeiou",
          "name" : "aeiou",
          "statement" : "aeiou",
          "defaultValues" : [ "aeiou" ],
          "labelHint" : "aeiou",
          "parameters" : [ {
            "name" : "aeiou",
            "value" : "aeiou"
          } ],
          "placeHolder" : "aeiou"
        } ]
      } ]
    },
    "forms" : [ {
      "panels" : [ {
        "layout" : "aeiou",
        "onCreate" : true,
        "multiUpload" : true,
        "name" : "aeiou",
        "styleName" : "aeiou",
        "label" : "aeiou",
        "onUpdate" : true,
        "properties" : [ {
          "widget" : "aeiou",
          "formLength" : "aeiou",
          "validators" : [ "aeiou" ],
          "values" : [ {
            "value" : "aeiou",
            "key" : "aeiou"
          } ],
          "multiple" : true,
          "label" : "aeiou",
          "styleName" : "aeiou",
          "type" : "aeiou",
          "styleNameLabel" : "aeiou",
          "copyFrom" : [ "aeiou" ],
          "widgetTitle" : "aeiou",
          "formHeight" : "aeiou",
          "name" : "aeiou",
          "defaultValues" : [ "aeiou" ],
          "labelHint" : "aeiou",
          "parameters" : [ {
            "name" : "aeiou",
            "value" : "aeiou"
          } ],
          "placeHolder" : "aeiou"
        } ],
        "order" : "aeiou"
      } ],
      "id" : "aeiou"
    } ],
    "views" : [ {
      "id" : "aeiou",
      "properties" : [ {
        "widget" : "aeiou",
        "formLength" : "aeiou",
        "values" : [ {
          "value" : "aeiou",
          "key" : "aeiou"
        } ],
        "multiple" : true,
        "label" : "aeiou",
        "styleName" : "aeiou",
        "type" : "aeiou",
        "styleNameLabel" : "aeiou",
        "copyFrom" : [ "aeiou" ],
        "widgetTitle" : "aeiou",
        "formHeight" : "aeiou",
        "name" : "aeiou",
        "defaultValues" : [ "aeiou" ],
        "labelHint" : "aeiou",
        "parameters" : [ {
          "name" : "aeiou",
          "value" : "aeiou"
        } ],
        "placeHolder" : "aeiou"
      } ]
    } ]
  }
}
      

Responses

200

OK. MdsEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /mds/v1/metadatasets/{repository}

Get metadata sets of repository. ( getMetadataSets)
Get metadata sets of repository.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)

Return type

Example data

Content-Type: application/json
        {
  "metadatasets" : [ {
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "isDefaultMds" : true
  } ]
}
      

Responses

200

OK. MdsEntries

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

post /mds/v1/metadatasets/{repository}/{metadataset}/values

Get values. ( getValues)
Get values.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
metadataset (required)
Path Parameter — ID of metadataset (or \"-default-\" for default metadata set)

Request body

body (required)
Body Parameter — value

Return type

Example data

Content-Type: application/json
        {
  "mds" : {
    "types" : [ {
      "type" : "aeiou",
      "properties" : [ {
        "defaultValue" : "aeiou",
        "name" : "aeiou",
        "multiple" : true,
        "processtype" : "aeiou",
        "type" : "aeiou",
        "keyContenturl" : "aeiou",
        "concatewithtype" : true,
        "copyFrom" : "aeiou"
      } ]
    } ],
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "lists" : [ {
      "id" : "aeiou",
      "label" : "aeiou",
      "properties" : [ {
        "widget" : "aeiou",
        "formLength" : "aeiou",
        "values" : [ {
          "value" : "aeiou",
          "key" : "aeiou"
        } ],
        "multiple" : true,
        "label" : "aeiou",
        "styleName" : "aeiou",
        "type" : "aeiou",
        "styleNameLabel" : "aeiou",
        "copyFrom" : [ "aeiou" ],
        "widgetTitle" : "aeiou",
        "formHeight" : "aeiou",
        "name" : "aeiou",
        "defaultValues" : [ "aeiou" ],
        "labelHint" : "aeiou",
        "parameters" : [ {
          "name" : "aeiou",
          "value" : "aeiou"
        } ],
        "placeHolder" : "aeiou"
      } ]
    } ],
    "queries" : {
      "baseQuery" : "aeiou",
      "queries" : [ {
        "layout" : "aeiou",
        "handlerclass" : "aeiou",
        "widget" : "aeiou",
        "criteriaboxid" : "aeiou",
        "statement" : "aeiou",
        "stylename" : "aeiou",
        "join" : "aeiou",
        "label" : "aeiou",
        "properties" : [ {
          "multipleJoin" : "aeiou",
          "widget" : "aeiou",
          "initByGetParam" : "aeiou",
          "formLength" : "aeiou",
          "validators" : [ "aeiou" ],
          "values" : [ {
            "value" : "aeiou",
            "key" : "aeiou"
          } ],
          "multiple" : true,
          "label" : "aeiou",
          "styleName" : "aeiou",
          "type" : "aeiou",
          "styleNameLabel" : "aeiou",
          "copyFrom" : [ "aeiou" ],
          "toogle" : true,
          "widgetTitle" : "aeiou",
          "formHeight" : "aeiou",
          "name" : "aeiou",
          "statement" : "aeiou",
          "defaultValues" : [ "aeiou" ],
          "labelHint" : "aeiou",
          "parameters" : [ {
            "name" : "aeiou",
            "value" : "aeiou"
          } ],
          "placeHolder" : "aeiou"
        } ]
      } ]
    },
    "forms" : [ {
      "panels" : [ {
        "layout" : "aeiou",
        "onCreate" : true,
        "multiUpload" : true,
        "name" : "aeiou",
        "styleName" : "aeiou",
        "label" : "aeiou",
        "onUpdate" : true,
        "properties" : [ {
          "widget" : "aeiou",
          "formLength" : "aeiou",
          "validators" : [ "aeiou" ],
          "values" : [ {
            "value" : "aeiou",
            "key" : "aeiou"
          } ],
          "multiple" : true,
          "label" : "aeiou",
          "styleName" : "aeiou",
          "type" : "aeiou",
          "styleNameLabel" : "aeiou",
          "copyFrom" : [ "aeiou" ],
          "widgetTitle" : "aeiou",
          "formHeight" : "aeiou",
          "name" : "aeiou",
          "defaultValues" : [ "aeiou" ],
          "labelHint" : "aeiou",
          "parameters" : [ {
            "name" : "aeiou",
            "value" : "aeiou"
          } ],
          "placeHolder" : "aeiou"
        } ],
        "order" : "aeiou"
      } ],
      "id" : "aeiou"
    } ],
    "views" : [ {
      "id" : "aeiou",
      "properties" : [ {
        "widget" : "aeiou",
        "formLength" : "aeiou",
        "values" : [ {
          "value" : "aeiou",
          "key" : "aeiou"
        } ],
        "multiple" : true,
        "label" : "aeiou",
        "styleName" : "aeiou",
        "type" : "aeiou",
        "styleNameLabel" : "aeiou",
        "copyFrom" : [ "aeiou" ],
        "widgetTitle" : "aeiou",
        "formHeight" : "aeiou",
        "name" : "aeiou",
        "defaultValues" : [ "aeiou" ],
        "labelHint" : "aeiou",
        "parameters" : [ {
          "name" : "aeiou",
          "value" : "aeiou"
        } ],
        "placeHolder" : "aeiou"
      } ]
    } ]
  }
}
      

Responses

200

OK. MdsEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /network/v1/repositories

Get repositories. ( getRepositories)
Get repositories.

Return type

Example data

Content-Type: application/json
        {
  "repositories" : [ {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "isHomeRepo" : true,
    "id" : "aeiou",
    "title" : "aeiou"
  } ]
}
      

Responses

200

OK. RepoEntries

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

post /node/v1/nodes/{repository}/{node}/content

Change content of node (new version). ( changeContentWithVersioning)
Change content of node (new version).

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node

Consumes

This API call consumes the following media types via the Content-Type request header:
  • multipart/form-data

Query parameters

versionComment (required)
Query Parameter — comment
mimetype (required)
Query Parameter — MIME-Type

Form parameters

file (optional)
Form Parameter

Return type

Example data

Content-Type: application/json
        {
  "node" : {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  }
}
      

Responses

200

OK. NodeEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

put /node/v1/nodes/{repository}/{node}/metadata

Change metadata of node. ( changeMetadata)
Change metadata of node.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node

Request body

body (required)
Body Parameter — properties

Return type

Example data

Content-Type: application/json
        {
  "node" : {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  }
}
      

Responses

200

OK. NodeEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

post /node/v1/nodes/{repository}/{node}/metadata

Change metadata of node (new version). ( changeMetadataWithVersioning)
Change metadata of node (new version).

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node

Request body

body (required)
Body Parameter — properties

Query parameters

versionComment (required)
Query Parameter — comment

Return type

Example data

Content-Type: application/json
        {
  "node" : {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  }
}
      

Responses

200

OK. NodeEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

post /node/v1/nodes/{repository}/{node}/children

Create a new child. ( createChild)
Create a new child.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of parent node

Request body

body (required)
Body Parameter — properties

Query parameters

type (required)
Query Parameter — type of node
aspects (optional)
Query Parameter — aspects of node

Return type

Example data

Content-Type: application/json
        {
  "node" : {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  }
}
      

Responses

200

OK. NodeEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

post /node/v1/nodes/{repository}/{node}/children/_copy

Create a new child by copying. ( createChildByCopying)
Create a new child by copying.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of parent node

Query parameters

source (required)
Query Parameter — ID of source node
withChildren (required)
Query Parameter — flag for children

Return type

Example data

Content-Type: application/json
        {
  "node" : {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  }
}
      

Responses

200

OK. NodeEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

post /node/v1/nodes/{repository}/{node}/children/_move

Create a new child by moving. ( createChildByMoving)
Create a new child by moving.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of parent node

Query parameters

source (required)
Query Parameter — ID of source node

Return type

Example data

Content-Type: application/json
        {
  "node" : {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  }
}
      

Responses

200

OK. NodeEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

delete /node/v1/nodes/{repository}/{node}

Delete node. ( delete)
Delete node.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /node/v1/nodes/{repository}/{node}/children

Get children of node. ( getChildren)
Get children of node.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of parent node

Query parameters

maxItems (optional)
Query Parameter — maximum items per page default: 500 format: int32
skipCount (optional)
Query Parameter — skip a number of items default: 0 format: int32

Return type

Example data

Content-Type: application/json
        {
  "nodes" : [ {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  } ],
  "pagination" : {
    "total" : 123,
    "count" : 123,
    "from" : 123
  }
}
      

Responses

200

OK. NodeEntries

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /node/v1/nodes/{repository}/{node}/metadata

Get metadata of node. ( getMetadata)
Get metadata of node.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node

Return type

Example data

Content-Type: application/json
        {
  "node" : {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  }
}
      

Responses

200

OK. NodeEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /node/v1/nodes/{repository}

Searching nodes. ( getNodes)
Searching nodes.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)

Query parameters

query (required)
Query Parameter — lucene query
facettes (optional)
Query Parameter — facettes
maxItems (optional)
Query Parameter — maximum items per page default: 10 format: int32
skipCount (optional)
Query Parameter — skip a number of items default: 0 format: int32

Return type

Example data

Content-Type: application/json
        {
  "facettes" : [ {
    "values" : [ {
      "count" : 123,
      "value" : "aeiou"
    } ],
    "property" : "aeiou"
  } ],
  "nodes" : [ {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  } ],
  "pagination" : {
    "total" : 123,
    "count" : 123,
    "from" : 123
  }
}
      

Responses

200

OK. SearchResult

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /node/v1/nodes/{repository}/{node}/permissions

Get all permission of node. ( getPermission)
Get all permission of node.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node

Return type

Example data

Content-Type: application/json
        {
  "permissions" : {
    "localPermissions" : {
      "inherited" : true,
      "permissions" : [ {
        "authority" : {
          "authorityName" : "aeiou",
          "authorityType" : "aeiou"
        },
        "permission" : "aeiou"
      } ]
    },
    "inheritedPermissions" : [ "" ]
  }
}
      

Responses

200

OK. NodePermissionEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /node/v1/nodes/{repository}/{node}/versions/{major}/{minor}/metadata

Get metadata of node version. ( getVersionMetadata)
Get metadata of node version.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node
major (required)
Path Parameter — major version format: int32
minor (required)
Path Parameter — minor version format: int32

Return type

Example data

Content-Type: application/json
        {
  "version" : {
    "contentUrl" : "aeiou",
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "comment" : "aeiou",
    "modifiedBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "version" : {
      "node" : {
        "repo" : "aeiou",
        "id" : "aeiou"
      },
      "major" : 123,
      "minor" : 123
    },
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  }
}
      

Responses

200

OK. NodeVersionEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /node/v1/nodes/{repository}/{node}/versions

Get all versions of node. ( getVersions)
Get all versions of node.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node

Return type

Example data

Content-Type: application/json
        {
  "versions" : [ {
    "node" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "major" : 123,
    "minor" : 123
  } ]
}
      

Responses

200

OK. NodeVersionRefEntries

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

put /node/v1/nodes/{repository}/{node}/versions/{major}/{minor}/_revert

Revert to node version. ( revertVersion)
Revert to node version.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node
major (required)
Path Parameter — major version format: int32
minor (required)
Path Parameter — minor version format: int32

Return type

Example data

Content-Type: application/json
        {
  "node" : {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  }
}
      

Responses

200

OK. NodeEntry

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

put /node/v1/nodes/{repository}/{node}/permissions

Set local permissions of node. ( setPermission)
Set local permissions of node.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
node (required)
Path Parameter — ID of node

Request body

body (required)
Body Parameter — permissions

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

put /organization/v1/organizations/{repository}/{organization}

Set organization of repository. ( createOrganizations)
Set organization of repository.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
organization (required)
Path Parameter — groupname

Query parameters

folder (required)
Query Parameter — ID of shared folder

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

delete /organization/v1/organizations/{repository}/{organization}

Delete organization of repository. ( deleteOrganizations)
Delete organization of repository.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
organization (required)
Path Parameter — groupname

Responses

200

OK.

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /organization/v1/organizations/{repository}

Get organizations of repository. ( getOrganizations)
Get organizations of repository.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)

Return type

Example data

Content-Type: application/json
        {
  "organizations" : [ {
    "groupName" : "aeiou",
    "authorityName" : "aeiou",
    "profile" : {
      "displayName" : "aeiou"
    },
    "sharedFolder" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "authorityType" : "aeiou"
  } ]
}
      

Responses

200

OK. OrganizationEntries

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

post /search/v1/queries/{repository}/{metadataset}/{query}

Perform queries based on metadata sets. ( search)
Perform queries based on metadata sets.

Path parameters

repository (required)
Path Parameter — ID of repository (or \"-home-\" for home repository)
metadataset (required)
Path Parameter — ID of metadataset (or \"-default-\" for default metadata set)
query (required)
Path Parameter — ID of query

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body (required)
Body Parameter — search parameters

Query parameters

maxItems (optional)
Query Parameter — maximum items per page default: 10 format: int32
skipCount (optional)
Query Parameter — skip a number of items default: 0 format: int32

Return type

Example data

Content-Type: application/json
        {
  "facettes" : [ {
    "values" : [ {
      "count" : 123,
      "value" : "aeiou"
    } ],
    "property" : "aeiou"
  } ],
  "nodes" : [ {
    "preview" : {
      "width" : 123,
      "url" : "aeiou",
      "height" : 123
    },
    "parent" : "",
    "access" : [ {
      "permission" : "aeiou",
      "hasRight" : true
    } ],
    "modifiedAt" : "2000-01-23T04:56:07.000+00:00",
    "aspects" : [ "aeiou" ],
    "description" : "aeiou",
    "type" : "aeiou",
    "title" : "aeiou",
    "createdAt" : "2000-01-23T04:56:07.000+00:00",
    "ref" : {
      "repo" : "aeiou",
      "id" : "aeiou"
    },
    "contentUrl" : "aeiou",
    "size" : 123456789,
    "createdBy" : {
      "firstName" : "aeiou",
      "lastName" : "aeiou",
      "mailbox" : "aeiou"
    },
    "name" : "aeiou",
    "modifiedBy" : "",
    "mimetype" : "aeiou",
    "contentVersion" : "aeiou",
    "properties" : [ {
      "values" : [ "aeiou" ],
      "name" : "aeiou"
    } ]
  } ],
  "pagination" : {
    "total" : 123,
    "count" : 123,
    "from" : 123
  }
}
      

Responses

200

OK. SearchResult

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /usage/v1/usages/{appId}

Get all usages of an application. ( getUsages)
Get all usages of an application.

Path parameters

appId (required)
Path Parameter — ID of application (or \"-home-\" for home repository)

Return type

Example data

Content-Type: application/json
        {
  "usages" : [ {
    "appUser" : "aeiou",
    "usageXmlParams" : "aeiou",
    "resourceId" : "aeiou",
    "distinctPersons" : 123,
    "parentNodeId" : "aeiou",
    "usageCounter" : 123,
    "appUserMail" : "aeiou",
    "toUsed" : "2000-01-23T04:56:07.000+00:00",
    "fromUsed" : "2000-01-23T04:56:07.000+00:00",
    "appId" : "aeiou",
    "guid" : "aeiou",
    "usageVersion" : "aeiou",
    "courseId" : "aeiou",
    "nodeId" : "aeiou"
  } ]
}
      

Responses

200

OK. Usages

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /usage/v1/usages/course/{appId}/{courseId}

Get all usages of an course. ( getUsagesByCourse)
Get all usages of an course.

Path parameters

appId (required)
Path Parameter — ID of application (or \"-home-\" for home repository)
courseId (required)
Path Parameter — ID of course

Return type

Example data

Content-Type: application/json
        {
  "usages" : [ {
    "appUser" : "aeiou",
    "usageXmlParams" : "aeiou",
    "resourceId" : "aeiou",
    "distinctPersons" : 123,
    "parentNodeId" : "aeiou",
    "usageCounter" : 123,
    "appUserMail" : "aeiou",
    "toUsed" : "2000-01-23T04:56:07.000+00:00",
    "fromUsed" : "2000-01-23T04:56:07.000+00:00",
    "appId" : "aeiou",
    "guid" : "aeiou",
    "usageVersion" : "aeiou",
    "courseId" : "aeiou",
    "nodeId" : "aeiou"
  } ]
}
      

Responses

200

OK. Usages

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

get /usage/v1/usages/node/{nodeId}

Get all usages of an node. ( getUsagesByNode)
Get all usages of an node.

Path parameters

nodeId (required)
Path Parameter — ID of node

Return type

Example data

Content-Type: application/json
        {
  "usages" : [ {
    "appUser" : "aeiou",
    "usageXmlParams" : "aeiou",
    "resourceId" : "aeiou",
    "distinctPersons" : 123,
    "parentNodeId" : "aeiou",
    "usageCounter" : 123,
    "appUserMail" : "aeiou",
    "toUsed" : "2000-01-23T04:56:07.000+00:00",
    "fromUsed" : "2000-01-23T04:56:07.000+00:00",
    "appId" : "aeiou",
    "guid" : "aeiou",
    "usageVersion" : "aeiou",
    "courseId" : "aeiou",
    "nodeId" : "aeiou"
  } ]
}
      

Responses

200

OK. Usages

400

Preconditions are not present. ErrorResponse

401

Authorization failed. ErrorResponse

403

Session user has insufficient rights to perform this operation. ErrorResponse

404

Ressources are not found. ErrorResponse

500

Fatal error occured. ErrorResponse

Up

Models

[ Jump to Methods ]

Table of Contents

  1. ACE
  2. ACL
  3. About
  4. Authority
  5. AuthorityEntries
  6. ErrorResponse
  7. Facette
  8. Group
  9. GroupEntries
  10. GroupEntry
  11. GroupProfile
  12. Mds
  13. MdsDesc
  14. MdsEntries
  15. MdsEntry
  16. MdsForm
  17. MdsFormPanel
  18. MdsFormProperty
  19. MdsFormPropertyParameter
  20. MdsFormPropertyValue
  21. MdsList
  22. MdsListProperty
  23. MdsListPropertyParameter
  24. MdsListPropertyValue
  25. MdsProperty
  26. MdsQueries
  27. MdsQuery
  28. MdsQueryCriteria
  29. MdsQueryProperty
  30. MdsQueryPropertyParameter
  31. MdsQueryPropertyValue
  32. MdsRef
  33. MdsType
  34. MdsView
  35. MdsViewProperty
  36. MdsViewPropertyParameter
  37. MdsViewPropertyValue
  38. Node
  39. NodeAccess
  40. NodeEntries
  41. NodeEntry
  42. NodePermissionEntry
  43. NodePermissions
  44. NodeProperty
  45. NodeRef
  46. NodeVersion
  47. NodeVersionEntry
  48. NodeVersionRef
  49. NodeVersionRefEntries
  50. Organization
  51. OrganizationEntries
  52. Pagination
  53. Person
  54. Preview
  55. Repo
  56. RepoEntries
  57. SearchParameters
  58. SearchResult
  59. Service
  60. ServiceInstance
  61. ServiceVersion
  62. Usage
  63. Usages
  64. User
  65. UserCredential
  66. UserEntries
  67. UserEntry
  68. UserProfile
  69. Value
  70. ValueParameters

ACE Up

authority
permission

ACL Up

inherited
permissions

About Up

version
services

Authority Up

authorityName
authorityType (optional)
Enum:
USER
GROUP
OWNER
EVERYONE
GUEST

AuthorityEntries Up

authorities

ErrorResponse Up

error
message

Facette Up

property
values

Group Up

authorityName
authorityType (optional)
Enum:
USER
GROUP
OWNER
EVERYONE
GUEST
groupName (optional)
profile (optional)

GroupEntries Up

groups

GroupEntry Up

group

GroupProfile Up

displayName (optional)

MdsDesc Up

ref
isDefaultMds

MdsEntries Up

metadatasets

MdsEntry Up

mds
Mds

MdsForm Up

MdsFormPanel Up

name
styleName
label
layout
onCreate
onUpdate
multiUpload
order
properties

MdsFormProperty Up

name
label
labelHint
formHeight
formLength
widget
widgetTitle
copyFrom
validators
parameters
values
defaultValues
multiple
placeHolder
styleName
styleNameLabel
type

MdsFormPropertyParameter Up

name
value

MdsFormPropertyValue Up

key
value

MdsList Up

id
label
properties

MdsListProperty Up

name
label
labelHint
formHeight
formLength
widget
widgetTitle
copyFrom
parameters
values
defaultValues
multiple
placeHolder
styleName
styleNameLabel
type

MdsListPropertyParameter Up

name
value

MdsListPropertyValue Up

key
value

MdsProperty Up

name
type
defaultValue
processtype
keyContenturl
concatewithtype
multiple
copyFrom

MdsQueries Up

baseQuery
queries

MdsQuery Up

criteriaboxid
handlerclass
join
label
layout
properties
statement
stylename
widget

MdsQueryCriteria Up

property
values

MdsQueryProperty Up

name
label
labelHint
formHeight
formLength
widget
widgetTitle
copyFrom
parameters
values
defaultValues
multiple
placeHolder
styleName
styleNameLabel
type
validators
statement
multipleJoin
toogle
initByGetParam

MdsQueryPropertyParameter Up

name
value

MdsQueryPropertyValue Up

key
value

MdsRef Up

repo
id

MdsType Up

type
properties

MdsView Up

MdsViewProperty Up

name
label
labelHint
formHeight
formLength
widget
widgetTitle
copyFrom
parameters
values
defaultValues
multiple
placeHolder
styleName
styleNameLabel
type

MdsViewPropertyParameter Up

name
value

MdsViewPropertyValue Up

key
value

Node Up

ref
parent (optional)
type (optional)
aspects (optional)
name
title (optional)
description (optional)
createdAt
Date format: date-time
createdBy
modifiedAt (optional)
Date format: date-time
modifiedBy (optional)
access
contentVersion
contentUrl
properties (optional)
mimetype (optional)
size (optional)
Long format: int64
preview (optional)

NodeAccess Up

permission (optional)
hasRight (optional)

NodeEntries Up

nodes
pagination

NodeEntry Up

node

NodePermissionEntry Up

permissions

NodePermissions Up

localPermissions
ACL
inheritedPermissions

NodeProperty Up

name
values (optional)

NodeRef Up

repo
id

NodeVersion Up

properties (optional)
version
comment
modifiedAt
Date format: date-time
modifiedBy
contentUrl (optional)

NodeVersionEntry Up

version

NodeVersionRef Up

node
major
Integer format: int32
minor
Integer format: int32

NodeVersionRefEntries Up

Organization Up

authorityName
authorityType (optional)
Enum:
USER
GROUP
OWNER
EVERYONE
GUEST
groupName (optional)
profile (optional)
sharedFolder (optional)

OrganizationEntries Up

organizations

Pagination Up

total
Integer format: int32
from
Integer format: int32
count
Integer format: int32

Person Up

firstName (optional)
lastName (optional)
mailbox (optional)

Preview Up

url
width
Integer format: int32
height
Integer format: int32

Repo Up

id
title
preview
isHomeRepo

RepoEntries Up

repositories

SearchParameters Up

SearchResult Up

nodes
pagination
facettes

Service Up

ServiceInstance Up

version
endpoint

ServiceVersion Up

major
Integer format: int32
minor
Integer format: int32

Usage Up

fromUsed (optional)
Date format: date-time
toUsed (optional)
Date format: date-time
usageCounter (optional)
Integer format: int32
appUser
appUserMail
courseId
distinctPersons (optional)
Integer format: int32
appId
nodeId
parentNodeId
usageVersion
usageXmlParams (optional)
resourceId
guid (optional)

Usages Up

usages (optional)

User Up

authorityName
authorityType (optional)
Enum:
USER
GROUP
OWNER
EVERYONE
GUEST
userName (optional)
profile (optional)
homeFolder
sharedFolders (optional)

UserCredential Up

oldPassword (optional)
newPassword

UserEntries Up

users

UserEntry Up

person

UserProfile Up

firstName (optional)
lastName (optional)
email (optional)

Value Up

value
count
Integer format: int32

ValueParameters Up

query
property
pattern
String prefix of the value (or \"-all-\" for all values)