GET collaboration/service-desk-requests/{serviceDeskRequestId}/file-versions

List of file versions referenced by / linked to provided service desk request

Note: Log in to check if your API client have access to run this resource
Version: 3
Success HTTP Status Code: 200
Maximum items from list ($top): 80

Uri parameters

{serviceDeskRequestId} Integer Service desk request identifier

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 is 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.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

File.
Category
String
Module of the file.
File.
Description
String
Description of file.
File.
Extension
String
Extension of the file (ex. jpg).
File.
Filename
String
Filename of the file.
File.
Size
Long
Size of the file.
FileVersionId String File identifier.
Status Integer Status of file version.
Version Integer Version of the file.
VersionDate Date Issuedate of the file version. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
VersionDescription String Version description of the file version.
VersionTime Time Issuetime of the file version.

See the page about filters and sorting on how to use sortable parameters

File.
Category
String
Module of the file
File.
Description
String
Description of file
File.
Extension
String
Extension of the file (ex. jpg)
File.
Filename
String
Filename of the file
File.
Size
Long
Size of the file
FileVersionId String File identifier
Status Integer Status of file version
Version Integer Version of the file
VersionDate Date Issuedate of the file version
VersionDescription String Version description of the file version
VersionTime Time Issuetime of the file version

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
<FileVersions>
2
     <FileVersion>
3
          <FileVersionId
FileVersionId

File identifier

>
{String}</FileVersionId>
4
          <Status
Status

Status of file version

>
{Integer}</Status>
5
          <File>
6
               <Filename
Filename

Filename of the file

>
{String}</Filename>
7
               <Description
Description

Description of file

>
{String}</Description>
8
               <Category
Category

Module of the file

>
{String}</Category>
9
               <Size
Size

Size of the file

>
{Long}</Size>
10
               <Extension
Extension

Extension of the file (ex. jpg)

>
{String}</Extension>
11
          </File>
12
          <Version
Version

Version of the file

>
{Integer}</Version>
13
          <VersionDate
VersionDate

Issuedate of the file version

>
{Date}</VersionDate>
14
          <VersionTime
VersionTime

Issuetime of the file version

>
{Time}</VersionTime>
15
          <VersionDescription
VersionDescription

Version description of the file version

>
{String}</VersionDescription>
16
          <FileVersionLink
FileVersionLink

File reference

>
{String}</FileVersionLink>
17
     </FileVersion>
18
</FileVersions>
1
{
2
     "fileVersions": [
3
          {
4
               "fileVersionId
FileVersionId

File identifier

":
"{String}",
5
               "status
Status

Status of file version

":
"{Integer}",
6
               "file": {
7
                    "filename
Filename

Filename of the file

":
"{String}",
8
                    "description
Description

Description of file

":
"{String}",
9
                    "category
Category

Module of the file

":
"{String}",
10
                    "size
Size

Size of the file

":
"{Long}",
11
                    "extension
Extension

Extension of the file (ex. jpg)

":
"{String}"
12
               },
13
               "version
Version

Version of the file

":
"{Integer}",
14
               "versionDate
VersionDate

Issuedate of the file version

":
"{Date}",
15
               "versionTime
VersionTime

Issuetime of the file version

":
"{Time}",
16
               "versionDescription
VersionDescription

Version description of the file version

":
"{String}",
17
               "fileVersionLink
FileVersionLink

File reference

":
"{String}"
18
          }
19
     ]
20
}

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 100107 HTTP 404 Service desk request not found
Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects