API

Collaboration APIs

GET collaboration/files/{fileId}

File details for provided identifier

HTTP method GET
URI https://api.rambase.net/collaboration/files/{fileId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {fileId} File identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 3158, version 14

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
1

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

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. Fields colored in grey is expandable fields.

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

Format:
1
<File>
2
     <FileId
FileId

File identifier

>{Integer}</FileId>
3
     <Description
Description

Description of file

>{String}</Description>
4
     <SearchTag
SearchTag

Search words that can be used to find and recognize files in search

>{String}</SearchTag>
5
     <Revision
Revision

The file revision is a freetext field and can be used in production for drawings and procedures etc. The revision field can only be set when creating a file, and never changed. If a file gets a new revision, a new file should be uploaded.

>{String}</Revision>
6
     <FileType
FileType

Type of file

>
7
          <FileTypeId
FileTypeId

Unique identifier for a file type

>{Integer}</FileTypeId>
8
          <Name
Name

Strong typed name for a file type

>{String}</Name>
9
          <FileTypeLink
FileTypeLink

Unique identifier for a file type

>{String}</FileTypeLink>
10
     </FileType>
11
     <HighestFileVersion>
12
          <FileVersionId
FileVersionId

Version of the file

>{Integer}</FileVersionId>
13
          <Status
Status

Status of file version

Possible domain values can be found here

>{Integer}</Status>
14
          <Filename
Filename

Filename to display for the file version. Will be used when downloading the file.

>{String}</Filename>
15
          <FileExtension
FileExtension

Extension of the file (ex. jpg)

>{String}</FileExtension>
16
          <DocumentReference
DocumentReference

This field is a freetext field that is maintained by user input and is intended to reflect the file contents identification reference for better document recognition purposes.

>{String}</DocumentReference>
17
          <InternalFilename
InternalFilename

The internal filename is created automatically based on the ruleset defined for the FileType. The ruleset consists of text and data macros that are combined to create an internal filename when a file is first uploaded. Data macros are only included in the filename if the connected file object matches the object types specified in the filetype ruleset.

>{String}</InternalFilename>
18
          <ChangeDescription
ChangeDescription

Version description of the file version

>{String}</ChangeDescription>
19
          <CreatedAt
CreatedAt

Date and time when this version was created

>{Datetime}</CreatedAt>
20
          <HashCode
HashCode

Unique hash to identify and verify a file

>{String}</HashCode>
21
          <FileSize
FileSize

Size of the file in bytes

>{Integer}</FileSize>
22
          <IsInternal
IsInternal

Flag to indicate that a file is for inhouse use only. Not to be sent to customers or suppliers.

>{Boolean}</IsInternal>
23
          <InternalPath
InternalPath

Physical file storage path.

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.InternalPath in your request URI to get this field

>{String}</InternalPath>
24
          <DownloadUri
DownloadUri

The url to download a file

>{String}</DownloadUri>
25
          <PdfInternalPath
PdfInternalPath

Physical file storage path for the pdf shadow file.

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.PdfInternalPath in your request URI to get this field

>{String}</PdfInternalPath>
26
          <PdfDownloadUri
PdfDownloadUri

The url to download the pdf shadow file

>{String}</PdfDownloadUri>
27
          <CurrentUserPermissions
CurrentUserPermissions

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.CurrentUserPermissions in your request URI to get this field

>
28
               <CanRead
CanRead

Permission to view the contents of a file. This permission does not inhibit accessibility to see metadata for a file, such as filename, searchtags etc.

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.CurrentUserPermissions in your request URI to get this field

>{Boolean}</CanRead>
29
               <CanWrite
CanWrite

Permission to make a new version of a file. This permission deos not inhibit a user from updating a files metadata such as filename and searhtags etc

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.CurrentUserPermissions in your request URI to get this field

>{Boolean}</CanWrite>
30
               <CanDetach
CanDetach

Permission to detach a file from its RamBase Object.

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.CurrentUserPermissions in your request URI to get this field

>{Boolean}</CanDetach>
31
          </CurrentUserPermissions>
32
          <FileVersionLink
FileVersionLink

File version reference

>{String}</FileVersionLink>
33
     </HighestFileVersion>
34
     <FileLink
FileLink

File reference

>{String}</FileLink>
35
</File>
1
{
2
     "file": {
3
          "fileId
FileId

File identifier

": "{Integer}",
4
          "description
Description

Description of file

": "{String}",
5
          "searchTag
SearchTag

Search words that can be used to find and recognize files in search

": "{String}",
6
          "revision
Revision

The file revision is a freetext field and can be used in production for drawings and procedures etc. The revision field can only be set when creating a file, and never changed. If a file gets a new revision, a new file should be uploaded.

": "{String}",
7
          "fileType
FileType

Type of file

": {
8
               "fileTypeId
FileTypeId

Unique identifier for a file type

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

Strong typed name for a file type

": "{String}",
10
               "fileTypeLink
FileTypeLink

Unique identifier for a file type

": "{String}"
11
          },
12
          "highestFileVersion": {
13
               "fileVersionId
FileVersionId

Version of the file

": "{Integer}",
14
               "status
Status

Status of file version

Possible domain values can be found here

": "{Integer}",
15
               "filename
Filename

Filename to display for the file version. Will be used when downloading the file.

": "{String}",
16
               "fileExtension
FileExtension

Extension of the file (ex. jpg)

": "{String}",
17
               "documentReference
DocumentReference

This field is a freetext field that is maintained by user input and is intended to reflect the file contents identification reference for better document recognition purposes.

": "{String}",
18
               "internalFilename
InternalFilename

The internal filename is created automatically based on the ruleset defined for the FileType. The ruleset consists of text and data macros that are combined to create an internal filename when a file is first uploaded. Data macros are only included in the filename if the connected file object matches the object types specified in the filetype ruleset.

": "{String}",
19
               "changeDescription
ChangeDescription

Version description of the file version

": "{String}",
20
               "createdAt
CreatedAt

Date and time when this version was created

": "{Datetime}",
21
               "hashCode
HashCode

Unique hash to identify and verify a file

": "{String}",
22
               "fileSize
FileSize

Size of the file in bytes

": "{Integer}",
23
               "isInternal
IsInternal

Flag to indicate that a file is for inhouse use only. Not to be sent to customers or suppliers.

": "{Boolean}",
24
               "internalPath
InternalPath

Physical file storage path.

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.InternalPath in your request URI to get this field

": "{String}",
25
               "downloadUri
DownloadUri

The url to download a file

": "{String}",
26
               "pdfInternalPath
PdfInternalPath

Physical file storage path for the pdf shadow file.

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.PdfInternalPath in your request URI to get this field

": "{String}",
27
               "pdfDownloadUri
PdfDownloadUri

The url to download the pdf shadow file

": "{String}",
28
               "currentUserPermissions
CurrentUserPermissions

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.CurrentUserPermissions in your request URI to get this field

": {
29
                    "canRead
CanRead

Permission to view the contents of a file. This permission does not inhibit accessibility to see metadata for a file, such as filename, searchtags etc.

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.CurrentUserPermissions in your request URI to get this field

": "{Boolean}",
30
                    "canWrite
CanWrite

Permission to make a new version of a file. This permission deos not inhibit a user from updating a files metadata such as filename and searhtags etc

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.CurrentUserPermissions in your request URI to get this field

": "{Boolean}",
31
                    "canDetach
CanDetach

Permission to detach a file from its RamBase Object.

This field is greyed out because it is an expandable field. You have to add $expand=HighestFileVersion.CurrentUserPermissions in your request URI to get this field

": "{Boolean}"
32
               },
33
               "fileVersionLink
FileVersionLink

File version reference

": "{String}"
34
          },
35
          "fileLink
FileLink

File reference

": "{String}"
36
     }
37
}

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:

Error 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers