Classes

Members

Functions

FinApi

Kind: global class

new FinApi()

FIN API class

Many classes return a promise with a object that looks like {response, body, authenticated} where

• response: HTTP response object
• body: HTTP body contents
• authenticated: boolean flag if a JWT token was sent along with the request

RDF_FORMATS : Object

JSON_LD: application/ld+jsonN_TRIPLES: application/n-triplesRDF_XML: application/rdf+xmlSPARQL_UPDATE: application/sparql-updateN3: text/n3PLAIN: text/plainTURTLE: text/turtle

Kind: global variable

FILE_EXTENSIONS : Object

.json: application/ld+json.nt: application/n-triples.xml: application/rdf+xml.n3: text/n3.txt: text/plain.ttl: text/turtle

Kind: global variable

GET_JSON_ACCEPT : Object

Optional Accept HTTP header values for GET request of Content-Type=application/ld+json

Kind: global variable

GET_PREFER : Object

Optional Prefer HTTP header values for GET request

Kind: global variable

PUT_PEFER : Object

Optional Prefer HTTP header values for PUT request.Allows replacing the properties of a container without having to provide all of the server-managed triples.

Kind: global variable

setConfig(params)

Set the API config

To make authenticated requests you should supply either a username/refreshToken or username/password combo. Then if a JWT doesn't exist or is expired, the request function will fetch a new JWT before the request is made.

Kind: global function

| Param | Description | | --- | --- | | params | key/value pairs to set | | params.host | FIN host ex. http://mydams.org | | params.fcBasePath | Fedora base path (default: /fcrepo/rest) | | params.jwt | JWT Token | | params.refreshToken | refresh token to use if JWT expires | | params.username | username to use with refreshToken or password if JWT expires | | params.password | password to use if JWT expires | | params.transactionToken | custom transaction token |

getConfig() ⇒ Object

return config object

Kind: global function

isSuccess(response) ⇒ Boolean

Given a HTTP response see if response is in 200 range

Kind: global function

| Param | Type | Description | | --- | --- | --- | | response | Object | HTTP response object |

get(options) ⇒ Promise

Retrieve the content of the resource

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.path | String | resource path | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath |

head(options) ⇒ Promise

Retrieve HTTP headers of the resource

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.path | String | resource path | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath |

post(options) ⇒ Promise

Create new resources within a LDP container

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.path | String | resource path | | options.headers | Object | resource headers, key/value pairs | | options.file | Object | (optional) path to file to upload | | options.content | Object | (optional) content to upload | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath | | options.transactionToken | String | (optional) override config.transactionToken |

put(options) ⇒ Promise

Create a resource with a specified path, or replace the triples associated with a resource with the triples provided in the request body.

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.path | String | resource path | | options.headers | Object | resource headers, key/value pairs | | options.file | Object | (optional) path to file to upload | | options.content | Object | (optional) content to upload | | options.partial | Object | (optional) only partial update happening, sets Prefer header to handling=lenient; received="minimal" | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath | | options.transactionToken | String | (optional) override config.transactionToken |

patch(options) ⇒ Promise

Sparql base update

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.path | String | resource path | | options.headers | Object | resource headers, key/value pairs | | options.file | Object | (optional) path to file to upload | | options.content | Object | (optional) content to upload | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath | | options.transactionToken | String | (optional) override config.transactionToken |

delete(options) ⇒ Promise

Delete a resource

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.path | String | resource path | | options.permanent | Boolean | remove /fcr:tombstone as well | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath | | options.transactionToken | String | (optional) override config.transactionToken |

copy(options) ⇒ Promise

Copy a resource (and its subtree) to a new location

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.path | String | resource path | | options.destination | Boolean | path to copy resource to | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath | | options.transactionToken | String | (optional) override config.transactionToken |

move(options) ⇒ Promise

Move a resource (and its subtree) to a new location

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.path | String | resource path | | options.destination | Boolean | path to move resource to | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath | | options.transactionToken | String | (optional) override config.transactionToken |

startTransaction(options) ⇒ Promise

Start a new transaction, returns transation token.

Kind: global function
Returns: Promise - {response, body, authenticated, transactionToken}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath |

commitTransaction(options) ⇒ Promise

Commit transation

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath | | options.transactionToken | String | (optional) override config.transactionToken |

rollbackTransaction(options) ⇒ Promise

Rollback transation

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | arguments | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath | | options.transactionToken | String | (optional) override config.transactionToken |

getVersions(options) ⇒ Promise

Get a current version

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath |

getVersion(options) ⇒ Promise

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | | | options.versionName | String | version to get | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath |

createVersion(options) ⇒ Promise

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | | | options.versionName | String | version to create | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath |

revertToVersion(options) ⇒ Promise

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | | | options.versionName | String | version name to revert to | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath |

deleteVersion(options) ⇒ Promise

Kind: global function
Returns: Promise - {response, body, authenticated}

| Param | Type | Description | | --- | --- | --- | | options | Object | | | options.versionName | String | version to delete | | options.headers | Object | resource headers, key/value pairs | | options.host | String | (optional) override config.host | | options.fcBasePath | String | (optional) override config.fcBasePath |