REST API

Document Enrichers

Updated: December 19, 2019

This page is scheduled for review and update. Check back soon for updated content!

acls

Get the document ACLs.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: acls

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "acls": [
      {
        "name": string,
        "aces": [
          {
            "id": string,
            "username": string | User entity,
            "externalUser": boolean,
            "permission": string,
            "granted": boolean,
            "creator": string | User entity,,
            "begin": datetime,
            "end": datetime,
            "status": string,
            "notify": boolean,
            "comment": string
          }
        ]
      }
    ]
  }
}
Property Name Value Description Notes
name string The ACL name.
aces[] list The list of the ACEs (Access Control Entry).
aces[].id string The ACE id.
aces[].username string
or object
The ACE username.
Or the ACE username user entity, if the fetch property username is set.
aces[].externalUser string The ACL name.
aces[].permission string The ACE permission.
aces[].granted boolean Whether the ACE is granted.
aces[].creator string
or object
The ACE creator.
Or the ACE creator user entity, if the fetch property creator is set.
aces[].begin datetime The ACE begin date (W3C date-time).
aces[].end datetime The ACE end date (W3C date-time).
aces[].status string The ACE status. Value: pending, effective or archived.
aces[].notify boolean Whether to notify the user when the ACE becomes effective. Optional
aces[].comment string The comment for the user when the ACE becomes effective. Optional

audit

Get the document latest log entries.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: audit

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "audit": [
      Log Entry entity,
    ]
  }
}

Get the list of all parent documents.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: breadcrumb

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "breadcrumb": {
      "entity-type": "documents",
      "entries": [
        Document entity
      ]
    }
  }
}

children

Get the list of all children documents.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: children

Resource Representation

{
  "entity-type": "document",
  "path": "/default-domain",
  ...
  "contextParameters": {
    "children": {
      "entity-type": "documents",
      "entries": [
        Document entity
      ]
    }
  }
}

collections

Get the collections the document belongs to.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: collections

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "collections": [
      Document entity
    ]
  }
}

documentURL

Get the document URL.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: documentURL

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "documentURL": string
}
Property Name Value Description Notes
documentURL string The document URL.

favorites

Add a Boolean flag indicating whether the document belongs to the user's Favorites.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: favorites

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "favorites": boolean
}
Property Name Value Description Notes
favorites boolean Whether the document belongs to the user's Favorites.

firstAccessibleAncestor

Get the closest accessible document's ancestor.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: firstAccessibleAncestor

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "firstAccessibleAncestor": Document entity
  }
}

hasContent

Add a boolean flag indicating whether the document has children or members.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: hasContent

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "hasContent": boolean
}
Property Name Value Description Notes
hasContent boolean Whether the document has children or members.

hasFolderishChild

Add a boolean flag indicating whether the document has folderish children.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: hasFolderishChild

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "hasFolderishChild": boolean
}
Property Name Value Description Notes
favorites hasFolderishChild Whether the document has folderish children.

highlight

Get the Elasticsearch highlights for a page provider.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/search/lang/pp/PAGE_PROVIDER_NAME
enrichers.document: highlight

Resource Representation

{
  "entity-type": "documents",
  "entries" : [
    {
      "entity-type": "document",
      "contextParameters": {
        "highlight": [
          {
            "field": string,
            "segments": [
              string
            ]
          }
        ]
      }
    }
  ],
  ...
}
Property Name Value Description Notes
field string The highlight field.
segments list The list of segments with highlighted text for the given field.

pendingTasks

Get the document pending tasks for the current user.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: pendingTasks

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "pendingTasks": [
      Task entity
    ]
}

permissions

Get the permissions available for the current user.

###Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: permissions

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "permissions": [
      string
    ]
}
Property Name Value Description Notes
permissions list The list of available permissions for the current user.

preview

Get the preview URL.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: preview

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "preview": {
      "url": string
    }
}
Property Name Value Description Notes
url string The document preview URL.

publications

Get the document publications count.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: publications

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "publications": {
      "resultCount": long
    }
}
Property Name Value Description Notes
resultCount long The document publications count.

renditions

Get the document renditions.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: renditions

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "renditions": [
      {
        "name": string,
        "kind": string,
        "icon": string,
        "url": string
      }
    ]
}
Property Name Value Description Notes
name string The rendition name.
kind string The rendition kind.
icon string The rendition icon URL.
url string The rendition URL.

runnableWorkflows

Get document runnable workflows for the current user.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: runnableWorkflows

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "runnableWorkflows": [
      Document entity
    ]
}

runningWorkflows

Get document running workflows for the current user.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: runningWorkflows

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "runningWorkflows": [
      Workflow entity
    ]
}

subscribedNotifications

Get the current user subscribed notifications for the document.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: subscribedNotifications

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "subscribedNotifications": [
      string
    ]
}
Property Name Value Description Notes
subscribedNotifications list The list of subscribed notifications.

subtypes

Get the document allowed subtypes.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: subtypes

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "subtypes": [
      {
        "type": string,
        "facets": [
          string,
        ]
      }
    ]
}
Property Name Value Description Notes
type string The subtype type.
facets list The subtype facets.

tags

Get the document tags.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: tags

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "tags": [
      string
    ]
}
Property Name Value Description Notes
tags list The list of tags.

thumbnail

Get the document thumbnail URL.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: thumbnail

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "thumbnail": {
      "url": string
    }
}
Property Name Value Description Notes
url string The thumbnail URL.

userVisiblePermissions

Get the document user visible permissions.

Invokation

GET https://NUXEO_SERVER/nuxeo/api/v1/id/DOC_ID
enrichers.document: userVisiblePermissions

Resource Representation

{
  "entity-type": "document",
  ...
  "contextParameters": {
    "userVisiblePermissions": [
      string
    ]
}
Property Name Value Description Notes
userVisiblePermissions list The document user visible permissions.

We'd love to hear your thoughts!

All fields required