Class: module:api/VersionsApi

module:api/VersionsApi(apiClient)

new module:api/VersionsApi(apiClient)

Constructs a new VersionsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Methods

getVersion(projectId, versionId, oauth2client, credentials)

Returns the version with the given version_id.

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id data is of type: {module:model/Version}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getVersion2(projectId, versionId, opts, oauth2client, credentials)

Returns the version with the given version_id.

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified data is of type: {module:model/Version}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getVersionDownloadFormats(projectId, versionId, opts, oauth2client, credentials)

Returns a collection of file formats this version could be converted to and downloaded as.

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified data is of type: {module:model/Version}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getVersionDownloads(projectId, versionId, opts, opts['filter[*]<-modifier>', oauth2client, credentials)

Returns a collection of file formats this version could be converted to and downloaded as.

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified
opts['filter[*]<-modifier>' Array.<*>

generic filter / <-modifier> is optional data is of type: {module:model/Version}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getVersionItem(projectId, versionId, oauth2client, credentials)

Returns the item the given version is associated with.

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id data is of type: {module:model/Item}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getVersionItem2(projectId, versionId, opts, oauth2client, credentials)

Returns the item the given version is associated with.

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified data is of type: {module:model/Item}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getVersionRefs(projectId, versionId, opts, opts['filter[*]<-modifier>', oauth2client, credentials)

Returns the resources (items, folders, and versions) which have a custom relationship with the given version_id. Custom relationships can be established between a version of an item and other resources within the 'data' domain service (folders, items, and versions).

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified
filterType Array.<String>

filter by the type of the ref target
filterId Array.<String>

filter by the id of the ref target
filterExtensionType Array.<String>

filter by the extension type
opts['filter[*]<-modifier>' Array.<*>

generic filter / <-modifier> is optional data is of type: {module:model/JsonApiCollection}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

Returns a collection of links for the given item_id-version_id object.

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified
opts['filter[*]<-modifier>' Array.<*>

generic filter / <-modifier> is optional data is of type: {module:model/JsonApiCollection}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getVersionRelationshipsRefs(projectId, versionId, opts, opts['filter[*]<-modifier>', oauth2client, credentials)

Returns the custom relationships that are associated to the given version_id. Custom relationships can be established between a version of an item and other resources within the 'data' domain service (folders, items, and versions).

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified
filterType Array.<String>

filter by the type of the ref target
filterId Array.<String>

filter by the id of the ref target
filterRefType Array.<String>

filter by refType
filterDirection module:model/String

filter by the direction of the reference
filterExtensionType Array.<String>

filter by the extension type
opts['filter[*]<-modifier>' Array.<*>

generic filter / <-modifier> is optional data is of type: {module:model/Refs}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

patchVersion(projectId, versionId, opts, body, oauth2client, credentials)

Updates the properties of the given version_id object.

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified
body module:model/CreateRef

describe the ref to be created
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postVersion(projectId, body, oauth2client, credentials)

Creates a new version of an item in the 'data' domain service.

Parameters:
Name Type Description
projectId String

the project id
body module:model/CreateVersion

describe the version to be created data is of type: {module:model/VersionCreated}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postVersion2(projectId, body, opts, oauth2client, credentials)

Creates a new version of an item in the 'data' domain service.

Parameters:
Name Type Description
projectId String

the project id
body module:model/CreateVersion

describe the version to be created
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified data is of type: {module:model/VersionCreated}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postVersionRelationshipsRef(projectId, versionId, body, oauth2client, credentials)

Creates a custom relationship between a version and another resource within the 'data' domain service (folder, item, or version).

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
body module:model/CreateRef

describe the ref to be created
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

postVersionRelationshipsRef2(projectId, versionId, opts, body, oauth2client, credentials)

Creates a custom relationship between a version and another resource within the 'data' domain service (folder, item, or version).

Parameters:
Name Type Description
projectId String

the project id
versionId String

the version id
opts Object

Optional parameters

Properties
Name Type Description
xuserid String

API call will be limited to act on behalf of only the user specified
body module:model/CreateRef

describe the ref to be created
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source: