LdpContainerService

This service is automatically created by the LdpService with the key ldp.container.

Actions

The following service actions are available:

attach

• Attach a resource to a container

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of container to which the resource will be attached
resourceUri	String	required	URI of resource to attach

create

• Create a new LDP container
• This does not create the relative API routes.

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of the container to create
title	String		Title of the container
description	String		Description of the container

clear

• Delete all the resources attached to a container

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of the container to clear

detach

• Detach a resource from a container

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of container to which the resource will be detached
resourceUri	String	required	URI of resource to attach

exist

• Check if a container exists

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of container to check

Return

true or false

get

• Get all resources attached to a container
• Use the LDP ontology of BasicContainers

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of container
accept	string	required	Type to return (application/ld+json, text/turtle or application/n-triples)
webId	string	Logged user's webId	User doing the action

You can also pass parameters defined in the container options.

Return

Triples, Turtle or JSON-LD depending on accept type.

getAll

• Get the list of all existing containers

Return

Array of URIs

getPath

Get the container path based on the provided resourceType. For example, if you pass pair:ProjectType, it will return /pair/project-type. Ontologies must be previously registered or the action will throw an error.

Parameters

Property	Type	Default	Description
resourceType	String	required	URI or prefixed resource type

Return

The path of the container

getUris

• Get the list of all resources within a container

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of container

Return

Array of URIs

includes

• Checks if a resource is contained in the container

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of container
resourceUri	String	required	URI of resource

Return

Boolean

isEmpty

• Checks if a container is empty

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of container

Return

Boolean

patch

• Attach and/or detach resource(s) from a container

Parameters

Property	Type	Default	Description
containerUri	String	required	URI of container to which the resource will be attached or detached
sparqlUpdate	String	required	SPARQL UPDATE string with INSERT DATA and/or DELETE DATA statements (see below)
webId	string	Logged user's webId	User doing the action

The format of the update string is as follow:

PREFIX ldp: <http://www.w3.org/ns/ldp#>
INSERT DATA { <http://url/of/container> ldp:contains <http://url/of/resource/to/attach>. };
DELETE DATA { <http://url/of/container> ldp:contains <http://url/of/resource/to/detach>. };

Any remote RDF resource can be attached to a container, given that its server can answer a GET request on it that returns its content in Turtle format. This means that even other LDP servers than semapps can have their resources linked to a container.

post

• Generate an URI, create the resource (calling ldp.resource.create), and attach it to a container
• Content type can be triples, turtle or JSON-LD (see @semapps/mime-types package)

Parameters

Property	Type	Default	Description
resource	Object	required	Resource to create
containerUri	String	required	Container where the resource will be created
contentType	String	required	Type of provided resource (application/ld+json, text/turtle or application/n-triples)
webId	String	Logged user's webId	User doing the action
slug	String		Specific ID tu use for URI instead generated UUID

Return

String: URI of the created resource

Events

The following events are emitted.

ldp.container.attached

Sent after a resource is attached to a container

Payload

Property	Type	Description
containerUri	String	URI of container
resourceUri	String	URI of resource

ldp.container.detached

Sent after a resource is detached from a container

Payload

Property	Type	Description
containerUri	String	URI of container
resourceUri	String	URI of resource

ldp.container.patched

Sent after a PATCH operation on the container

Payload

Property	Type	Description
containerUri	String	URI of container