ContentFileService
Endpoint Metadata
- Namespace: http://opencase.extend.com/contentprocessor/webservices/contentfile
- Endpoint Name: ContentFileWebService
- Endpoint Address: http(s)://{VMS URL}/ContentProcessor/webservices/contentfile-service
The following methods are available on this endpoint:
Adds a new ContentFileMetadata object to the collection of a ContentFile entity.
Input Parameters
name |
type |
description |
contentFilePk |
integer |
The primary key java.lang.Integer of the ContentFile to which metadata will be added. |
metadata |
contentFileMetadata
|
The metadata that will be added to the content file. |
Faults
name |
description |
ContentFileWebServiceFault |
If contentFilePk is null or 0. |
Creates a new ContentFile entity using the provided entity object.
Input Parameters
name |
type |
description |
contentFileToCreate |
contentFile
|
The ContentFile entity to create. |
Return Value
type |
description |
contentFile
|
A newly created ContentFile entity. |
Faults
name |
description |
ContentFileWebServiceFault |
If the primary key, UUID, or creation date of the specified content file contain a value other thannull. |
Search for ContentFiles matching a collateId and abrType
Input Parameters
name |
type |
description |
collateId |
string |
the asset name |
abrType |
AbrType
|
type of the file in the asset |
Return Value
Faults
name |
description |
ContentFileWebServiceFault |
Throws if collateId, abrType is null or empty or some error prevented from finding ContentFiles. |
Search for ContentFiles matching a original source path.
Input Parameters
name |
type |
description |
originalSourcePath |
string |
the original source path |
pathType |
string |
the path type |
isBound |
boolean |
the is bound |
Return Value
Faults
name |
description |
ContentFileWebServiceFault |
Throws if originalSourcePath is null or empty or some error prevented from finding ContentFiles. |
Retrieves a ContentFile using its repository path.
Input Parameters
name |
type |
description |
repositoryPath |
string |
The full repository pathname of the content file. Format of repository path delimiter is /. com.extend.opencase.cp.session.repository.manager.BaseRepositoryManager#SEPARATOR |
Return Value
type |
description |
contentFile
|
The ContentFile or null if the content file cannot be found. |
Faults
name |
description |
ContentFileWebServiceFault |
If repositoryPath is empty or null. |
Retrieves a ContentFile using a unique UUID field.
Input Parameters
name |
type |
description |
uuid |
string |
The unique UUID of the content file to retrieve. |
Return Value
type |
description |
contentFile
|
The ContentFile or null if the content file cannot be found. |
Faults
name |
description |
ContentFileWebServiceFault |
If uuid is empty or null. |
Returns a metadata with given name for specified content file.
Input Parameters
name |
type |
description |
contentFilePk |
integer |
The primary key of the content file. |
metadataName |
string |
The name of metadata of content file. |
Return Value
type |
description |
contentFileMetadata
|
metadata with given name for content file with specified primary key. |
Faults
name |
description |
ContentFileWebServiceFault |
If contentFilePk equals null or 0 or metadataName equals null. |
Locks a content file with a specified content file primary key.
Input Parameters
name |
type |
description |
contentFilePk |
integer |
The primary key of the content file to lock. |
Return Value
type |
description |
boolean |
I a lock was successfully obtained for the specified content file, a value of true is returned. If no content filecould be found to unlock with the specified primary key, a value of false is returned. |
Removes ContentFileMetadata object, specified by primary key
Input Parameters
name |
type |
description |
metadataPk |
integer |
primary of the ContentFileMetadata that will be removed |
Faults
name |
description |
ContentFileWebServiceFault |
If metadataPk equals null or 0. |
Search content files by partial repository path.
Input Parameters
name |
type |
description |
partialPath |
string |
Part of repository path. |
isSourceFile |
boolean |
if true only files which has sourceFile=true will be retireved |
Return Value
Faults
name |
description |
ContentFileWebServiceFault |
If any error has prevented search of content files. |
Unlocks a content file with a specified content file primary key.
Input Parameters
name |
type |
description |
contentFilePk |
integer |
The primary key of the content file to unlock. |
Return Value
type |
description |
boolean |
I a lock was successfully released for the specified content file, a value of true is returned. If no content filecould be found to unlock with the specified primary key, a value of false is returned. |
Updates an existing ContentFile with the provided object searched by primary key. The ContentFile entity must alreadyexist within the system.
Input Parameters
name |
type |
description |
contentFileToUpdate |
contentFile
|
A ContentFile containing the updated fields to be persisted. |
Faults
name |
description |
ContentFileWebServiceFault |
If the passed content file is invalid. ContentFile entity is invalid when it isnull, UUID or creation date fields were modified |
Updates ContentFileMetadata object in the collection of a ContentFile entity.
Input Parameters
name |
type |
description |
contentFilePk |
integer |
The primary key java.lang.Integer of the ContentFile to which metadata will be updated. |
metadata |
contentFileMetadata
|
The metadata that will be updated in the content file. |
Faults
name |
description |
ContentFileWebServiceFault |
If contentFilePk is null or 0. |