API

Collaboration APIs

POST collaboration/file-folders/{fileFolderId}/shares

Creates a new share with a time-limited jwt token for public file share

HTTP method POST
URI https://api.rambase.net/collaboration/file-folders/{fileFolderId}/shares
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {fileFolderId} File folder id for a spesific file container or forlder.
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 4632, version 9

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<FileFolderShare>
2
     <ExpiresAt
ExpiresAt

Required/mandatory field

Absolute time for the share to expire

>{Datetime}</ExpiresAt>
3
     <Comment
Comment

Descriptive text or comment for the file share

This field is optional.

>{String}</Comment>
4
</FileFolderShare>
1
{
2
     "fileFolderShare": {
3
          "expiresAt
ExpiresAt

Required/mandatory field

Absolute time for the share to expire

": "{Datetime}",
4
          "comment
Comment

Descriptive text or comment for the file share

This field is optional.

": "{String}"
5
     }
6
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<FileFolderShare>
2
     <FileFolderShareId
FileFolderShareId

Unique identifier for a public share

>{Integer}</FileFolderShareId>
3
     <PublicToken
PublicToken

Token for the public file share access.

>{String}</PublicToken>
4
     <ExpiresAt
ExpiresAt

Absolute time for the share to expire

>{Datetime}</ExpiresAt>
5
     <SharedAt
SharedAt

Timestamp when the share was created

>{Datetime}</SharedAt>
6
     <Comment
Comment

Descriptive text or comment for the file share

>{String}</Comment>
7
     <SharedBy
SharedBy

PID for the person who created the share

>
8
          <UserId
UserId

User identifier

>{Integer}</UserId>
9
          <Name
Name

Name of the user

>{String}</Name>
10
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
11
          <UserLink
UserLink

User reference

>{String}</UserLink>
12
     </SharedBy>
13
</FileFolderShare>
1
{
2
     "fileFolderShare": {
3
          "fileFolderShareId
FileFolderShareId

Unique identifier for a public share

": "{Integer}",
4
          "publicToken
PublicToken

Token for the public file share access.

": "{String}",
5
          "expiresAt
ExpiresAt

Absolute time for the share to expire

": "{Datetime}",
6
          "sharedAt
SharedAt

Timestamp when the share was created

": "{Datetime}",
7
          "comment
Comment

Descriptive text or comment for the file share

": "{String}",
8
          "sharedBy
SharedBy

PID for the person who created the share

": {
9
               "userId
UserId

User identifier

": "{Integer}",
10
               "name
Name

Name of the user

": "{String}",
11
               "firstName
FirstName

First name of the user

": "{String}",
12
               "userLink
UserLink

User reference

": "{String}"
13
          }
14
     }
15
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: