This chapter details the DIVA Enterprise Connect services that process archived assets, which include the following services:
The following Web Services allow digital assets to be archived into the digital archive, restored to Source/Destinations, copied, or deleted. These commands typically run for a long time. When a call is successful, these services return a request ID (similar to a job ID). The request ID can then be passed as an argument to monitor the request as it is executed in the system.
archiveObject()This request enables digital assets to be transferred from a Source/Destination (for example, FTP or CIFS file system) to DIVArchive, resulting in a new archived object. If the request is created successfully, the call returns a request ID. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in DIVArchive and DIVAnet. DIVAnet will archive to the local site by default.
The following is a list of archiveObject() request input parameters:
Table 4-1 archiveObject() Request Input Parameters
| Parameter | Description | Data Type and Defaults |
|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (1 - 96 characters) This field is required. |
|
|
This parameter identifies the DIVArchive Source/Destination name (representing a server, or disk, such as FTP or CIFS) from where the files are ingested. |
String (1 - 96 characters) This field is required. |
|
|
This parameter identifies the DIVArchive media name, and refers to a collection of object instances stored on the same, or similar, disk or tape media. You can also specify a DIVArchive Storage Plan here. In this case, DIVArchive performs processing to determine which media to use for the archive. |
String (1 - 96 characters) This field is required. |
|
|
This parameter identifies the top-level subdirectory within the Source/Destination from where files should be archived. |
String (0 - 4000 characters) This can be empty. |
|
|
This parameter identifies a list of files (or wildcard patterns) to be archived. Paths for the files are relative to the specified <fileNamesList>misc/*</fileNamesList> <fileNamesList>t.mov</fileNamesList> If the |
String (1 - 4000 characters) This tag can appear one or more times. |
|
|
This parameter controls how requests are cached during request processing. The possible integer values are as follows:
|
Integer (0 - 6) This can be |
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
|
|
This parameter is an optional string containing information describing the object. |
String (0 - 4000 characters) This can be empty. |
|
|
This parameter identifies additional options for the archive command. These options are typically prefixed with a dash (similar to command line options). Some options can override parameters for the Source/Destination. Some typical archive options include:
|
String (0 - 768 characters) This can be empty. |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-2 archiveObject() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
The following are typical DIVArchive archiveObject() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided already exists in the DIVArchive or DIVAnet system.
The tape group provided does not exist in the target DIVArchive system.
The Source/Destination provided does not exist in the target DIVArchive system.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST archiveObject() request:
<p:archiveObject xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd"> <p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode> <p:objectName>PREPROD_July_Edits4</p:objectName> <p:objectCategory>PROD</p:objectCategory> <p:source>ftp_001</p:source> <p:mediaName>Post4LTO7</p:mediaName> <p:filesPathRoot></p:filesPathRoot> <!--1 or more repetitions:--> <p:fileNamesList>preprod_jul.mov</p:fileNamesList> <p:qualityOfService>1</p:qualityOfService> <p:priorityLevel>50</p:priorityLevel> <p:comments>This object was archived through a DIVA WS REST call</p:comments> <p:archiveOptions></p:archiveOptions> </p:archiveObject>
The following is an example of a REST response for an archiveObject() request:
<p:archiveObjectResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:archiveObjectResponse>
associativeCopy()This request enables storing a list of archived objects together on the same tape media. The request completes when all objects have been copied to the target tape. If the request is created successfully, the call returns a request ID. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in DIVArchive, but not in DIVAnet (MultiDIVA Mode).
The following is as list of associativeCopy() request input parameters:
Table 4-3 associativeCopy() Request Input Parameters
| Section | Parameter | Description | Data Type and Defaults |
|---|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
objectsInfo |
This section identifies a list of objects to be stored together. Each entry is a separate object, identified by an object name and category pair. The following is an example of two objects to be stored together: <objectsInfo> <objectName>OBJ1</objectName> <objectCategory>Air3</objectCategory> </objectsInfo> <objectsInfo> <objectName>OBJ2</objectName> <objectCategory>Air3</objectCategory> </objectsInfo> |
Can appear one or more times. |
|
|
objectsInfo |
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
objectsInfo |
|
This parameter identifies the name of the object category. This parameter, along with The request will fail if this field is empty, and more than one object in DIVArchive matches the |
String (1 - 96 characters) This field is can be empty. |
|
|
This parameter identifies the DIVArchive tape group name. This refers to a collection of object instances stored on the same, or similar, tape media. |
String (1 - 96 characters) This field is required. |
|
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-4 associativeCopy() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
The following are typical DIVArchive associativeCopy() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
The tape group provided does not exist in the target DIVArchive system.
There are no available instances of the object. For example, this could possibly occur because a required tape was ejected from a tape library.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST associativeCopy() request:
<p:associativeCopy xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd" xmlns:p1="http://model.api.ws.diva.fpdigital.com/xsd">
<p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode>
<p:objectsInfo>
<p1:objectName>PREPROD_July_Edits4</p1:objectName>
<p1:objectCategory>PROD</p1:objectCategory>
</p:objectsInfo>
<p:objectsInfo>
<p1:objectName>PREPROD_July_Edits5</p1:objectName>
<p1:objectCategory>PROD</p1:objectCategory>
</p:objectsInfo>
<p:groupName>Post4LTO7</p:groupName>
<p:priorityLevel>50</p:priorityLevel>
</p:associativeCopy>
The following is an example of a REST response for an associativeCopy() request:
<p:associativeCopyResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:associativeCopyResponse>
copy(), copyToGroup()This request creates a copy of an archived asset. This results in a new instance of the object within DIVArchive, not a new object. If you use DIVAnet, you can use this command to copy an object from one site to another. The target media of the new instance is passed. The call returns a request ID if the request is created successfully. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in both DIVArchive and DIVAnet.
The following is a list of copy() and copyToGroup() request input parameters:
Table 4-5 copy() and copyToGroup() Request Input Parameters
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
This parameter identifies the name of the object. This parameter, along with the |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (0 - 96 characters) You can leave this field empty. |
|
|
Specifying a value for this parameter enables the caller to select a specific object instance to copy from. |
Integer (0 - 100000). If you use |
|
|
This parameter identifies the DIVArchive media name. This refers to a collection of object instances stored on the same, or similar, disk or tape media. In DIVAnet, you can prefix a DIVArchive site name to the media using an underscore to separates the two. This allows objects to be copied to a particular site. |
String (1 - 96 characters) This field is required. |
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-6 copy() or copyToGroup() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
The following are typical DIVArchive copy() and copyToGroup() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
More than one object with the specified name exists in the DIVArchive or DIVAnet database.
The tape group provided does not exist in the target DIVArchive system.
There are no available instances of the object. For example, this could possibly occur because a required tape was ejected from a tape library.
The specified object instance does not exist in DIVArchive or DIVAnet.
One or more object instances are currently offline and cannot be processed.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST copy() and copyToGroup() request:
<p:copy xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd"> <p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode> <p:objectName>PREPROD_July_Edits4</p:objectName> <p:categoryName>PROD</p:categoryName> <p:instanceID>-1</p:instanceID> <p:priorityLevel>50</p:priorityLevel> <p:mediaName>Post4LTO7</p:mediaName> </p:copy>
The following is an example of a REST response for a copy() and copyToGroup() request:
<p:copyResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:copyResponse>
copyToNewObject()This request creates a copy of an archived object. This results in a new object within DIVArchive, not just a new object instance. You provide the target name, target category, and target media for the new object. The call returns a request ID if it the request is created successfully. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in DIVArchive, but not in DIVAnet (MultiDIVA mode).
The following is a list of copyToNewObject() request input parameters:
Table 4-7 copyToNew() Request Input Parameters
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (0 - 96 characters) You can leave this field empty. |
|
|
Specifying a value for this parameter enables the caller to select which media to perform the copy from. If this value and |
String (0 - 96 characters) You can leave this field empty. |
|
|
Specifying a value for this parameter enables the caller to select a specific object instance to copy from. If this value and |
Integer (0 - 100000).Entering |
|
|
This parameter identifies the target object name to be created. |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the target object category to be created. |
String (1 - 96 characters) This field is required. |
|
|
This parameter identifies the DIVArchive media name (either a tape group or array name). This refers to a collection of object instances stored on the same, or similar, disk or tape media. The target object is stored on the identified media. |
String (1 - 96 characters) This field is required. |
|
|
This parameter is an optional string containing information describing the object. |
String (0 - 4000 characters) You can leave this field empty. |
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-8 copyToNew() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
The following are typical DIVArchive copyToNew() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
More than one object with the specified name exists in the DIVArchive or DIVAnet database.
The tape group provided does not exist in the target DIVArchive system.
There are no available instances of the object. For example, this could possibly occur because a required tape was ejected from a tape library.
The specified object instance does not exist in DIVArchive or DIVAnet.
One or more object instances are currently offline and cannot be processed.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST copyToNewObject() request:
<p:copyToNewObject xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd"> <p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode> <p:objectName>PREPROD_July_Edits4</p:objectName> <p:objectCategory>PROD</p:objectCategory> <p:objectMedia>Post4LTO7</p:objectMedia> <p:objectInstanceID></p:objectInstanceID> <p:newObjectName>PREPROD_July_Edits4</p:newObjectName> <p:newObjectCategory>PROD</p:newObjectCategory> <p:newObjectInstanceMedia>Post4LTO7</p:newObjectInstanceMedia> <p:comments></p:comments> <p:priorityLevel>50</p:priorityLevel> </p:copyToNewObject>
The following is an example of a REST response for a copyToNewObject() request:
<p:copyToNewResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:copyToNewResponse>
deleteObject()The request deletes an archived object from DIVArchive. If you use DIVAnet, you can use this command to delete objects from all sites. The call returns a request ID if the request is created successfully. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in both DIVArchive and DIVAnet.
The following is a list of deleteObject() request input parameters:
Table 4-9 deleteObject() Request Input Parameters
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (0 - 96 characters) You can leave this field empty. |
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-10 deleteObject() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
The following are typical DIVArchive deleteObject() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
More than one object with the specified name exists in the DIVArchive or DIVAnet database.
The tape group provided does not exist in the target DIVArchive system.
One or more object instances are currently offline and cannot be processed.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST deleteObject() request:
<p:deleteObject xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd"> <p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode> <p:objectName>PREPROD_July_Edits4</p:objectName> <p:objectCategory>PROD</p:objectCategory> </p:deleteObject>
The following is an example of a REST response for a deleteObject() request:
<p:deleteObjectResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:deleteObjectResponse>
deleteInstance()The request deletes an archived object, or a single object instance from DIVArchive. If you use DIVAnet, you can delete an asset from all sites, a single site, or a single object instance on a site. You can provide an instance ID or media in addition to object name and category to select a particular object instance. The call returns a request ID if the request is created successfully. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in both DIVArchive and DIVAnet.
The following is a list of deleteInstance() request input parameters:
Table 4-11 deleteInstance() Request Input Parameters
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (0 - 96 characters) You can leave this field empty. |
|
|
This parameter identifies the DIVArchive media name. This refers to a collection of object instances stored on the same, or similar, disk or tape media. In DIVAnet, you can prefix a DIVArchive site name to the media using an underscore to separates the two. This allows objects to be deleted from a particular site. You cannot specify both this value and the |
String (1 - 96 characters) This field is required. |
|
|
Specifying a value for this parameter enables the caller to select a specific object instance to delete. You cannot specify both this value and the |
Integer (0 - 100000).Entering |
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-12 deleteInstance() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
The following are typical DIVArchive deleteInstance() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
More than one object with the specified name exists in the DIVArchive or DIVAnet database.
The tape group provided does not exist in the target DIVArchive system.
There are no available instances of the object. For example, this could possibly occur because a required tape was ejected from a tape library.
The specified object instance does not exist in DIVArchive or DIVAnet.
One or more object instances are currently offline and cannot be processed.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST deleteInstance() request:
<p:deleteInstance xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd"> <p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode> <p:objectName>PREPROD_July_Edits4</p:objectName> <p:categoryName>PROD</p: categoryName > <p:mediaName>Post4LTO7</p:mediaName> <p:priorityLevel>50</p:priorityLevel> </p:deleteInstance>
The following is an example of a REST response for a deleteInstance() request:
<p:deleteInstanceResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:deleteInstanceResponse>
restoreObject()This request enables restoring an object within DIVArchive to a Source/Destination (such as FTP or CIFS). This request restores all files and folders associated with the archived object. Optionally, you can select a specific DIVArchive object instance to read, and multiple Source/Destinations using the restoreInstance() call (see Restore Instance: restoreInstance() for information). This call returns a request ID if the request is created successfully. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in both DIVArchive and DIVAnet.
The following is a list of restoreObject() request input parameters:
Table 4-13 restoreObject() Request Input Parameters
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (0 - 96 characters) You can leave this field empty. |
|
|
This parameter identifies a DIVArchive Source/Destination name (representing a server or disk, such as FTP or CIFS). The archived object files are restored to this destination. |
String (1 - 96 characters) This field is required |
|
|
This parameter identifies the top-level subdirectory within the Source/Destination where files should be restored. If this value is not specified, the default stored in the |
String (0 - 4000 characters) This can be empty. |
|
|
This parameter controls how requests are cached during request processing. The possible integer values are as follows:
|
Integer (0 - 6) This can be |
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
|
|
This parameter identifies additional restore command options. These options typically are prefixed with a dash (similar to command line options). Some options can override parameters for the Source/Destination. Some typical restore options are a follows: Rename certain files: -rest_renaming <renamerule> Use certain transcoders: -tr_names <transcoder_list> Restored format: -tr_restore_format <format> Generate a metadata file on restore: -rm |
String (0 - 768 characters) You can leave this field empty. |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-14 restoreObject() Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 -1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
The following are typical DIVArchive restoreObject() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
More than one object with the specified name exists in the DIVArchive or DIVAnet database.
The Source/Destination name provided does not exist in DIVArchive.
There are no available instances of the object. For example, this could possibly occur because a required tape was ejected from a tape library.
One or more object instances are currently offline and cannot be processed.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST restoreObject() request:
<p:restoreObject xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd"> <p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode> <p:objectName>PREPROD_July_Edits4</p:objectName> <p:objectCategory>PROD</p:objectCategory> <p:destination>ftp_001</p:destination> <p:filesPathRoot></p:filesPathRoot> <p:qualityOfService>0</p:qualityOfService> <p:priorityLevel></p:priorityLevel> <p:restoreOptions></p:restoreOptions> </p:restoreObject>
The following is an example of a REST response for a restoreObject() request:
<p:restoreObjectResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:restoreObjectResponse>
restoreInstance()This request transfers an archived object from DIVArchive to a specified Source/Destination (such as FTP or CIFS). You can specify an instanceID to select a specific DIVArchive object instance to read. These calls return a request ID if the request is created successfully. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in both DIVArchive and DIVAnet.
The following is a list of restoreInstance() request input parameters:
Table 4-15 restoreInstance() Request Input Parameters
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (0 - 96 characters) You can leave this field empty. |
|
|
Specifying a value for this parameter enables the caller to select a specific object instance to delete. If DIVAnet is used, pass the DIVAnet object instance ID, which is unique among all sites. |
Integer (0 - 100000).This field is required. |
|
|
This parameter identifies a DIVArchive Source/Destination name (representing a server or disk, such as FTP or CIFS). The archived object files are restored to this destination. |
String (1 - 96 characters) This field is required |
|
|
This parameter identifies the top-level subdirectory within the Source/Destination where files should be restored. Setting this value overrides the default in the object. If this value is not specified, the default stored in the |
String (0 - 4000 characters) This can be empty. |
|
|
This parameter controls how requests are cached during request processing. The possible integer values are as follows:
|
Integer (0 - 6) This can be |
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
|
|
This parameter identifies additional restore command options. These options typically are prefixed with a dash (similar to command line options). Some options can override parameters for the Source/Destination. Some typical restore options are a follows: Rename certain files: -rest_renaming <renamerule> Use certain transcoders: -tr_names <transcoder_list> Restored format: -tr_restore_format <format> Generate a metadata file on restore: -rm |
String (0 - 768 characters) You can leave this field empty. |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-16 restoreInstance() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
Integer (1 - 10,000,000) |
The following are typical DIVArchive restoreInstance() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
More than one object with the specified name exists in the DIVArchive or DIVAnet database.
The Source/Destination name provided does not exist in DIVArchive.
There are no available instances of the object. For example, this could possibly occur because a required tape was ejected from a tape library.
The specified object instance does not exist in DIVArchive or DIVAnet.
One or more object instances are currently offline and cannot be processed.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST restoreInstance() request:
<p:restoreInstance xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd"> <p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode> <p:objectName>PREPROD_July_Edits4</p:objectName> <p:objectCategory>PROD</p:objectCategory> <p:destination>ftp_001</p:destination> <p:instanceID>-1</p:instanceID> <p:filesPathRoot></p:filesPathRoot> <p:qualityOfService>0</p:qualityOfService> <p:priorityLevel></p:priorityLevel> <p:restoreOptions></p:restoreOptions> </p:restoreInstance>
The following is an example of a REST response for a restoreInstance() request:
<p:restoreInstanceResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:restoreInstanceResponse>
multipleRestoreObject()This request transfers an archived object from DIVArchive to a specified Source/Destination (such as FTP or CIFS). This call allows the object to be transferred to multiple Source/Destinations. The call return a request ID if the request is created successfully. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This command completes when the object has been transferred to all Source/Destinations (successfully or not). This request is available in both DIVArchive and DIVAnet. DIVAnet (MultiDIVA mode) will restore from exactly one site to fulfill the request.
The following is a list of multipleRestoreObject() request input parameters:
Table 4-17 multipleRestoreObject() Request Input Parameters
| Section | Parameter | Description | Data Type and Default |
|---|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (0 - 96 characters) You can leave this field empty. |
|
|
destinations |
This section identifies a list of one or more DIVArchive Source/Destination names and path roots for each destination. The following is an example of two Source/Destinations: <p:destinations> <p:destination>POST2</p:destination> <p:filePathRoot>content</p:filePathRoot> </p:destinations> <p:destinations> <p:destination>POST3</p:destination> <p:filePathRoot></p:filePathRoot> </p:destinations> |
String (1 - 200 entries) This section is required. |
|
|
destinations |
|
This parameter identifies an item in the list of DIVArchive Source/Destination names. The object is restored to this destination and the others in the list. |
String (1 - 96 characters) This field is required. |
|
destinations |
|
This parameter identifies the top-level within the Source/Destination where files should be restored. If you supply an empty |
String (0 - 4000 characters) This can be empty. |
|
|
This parameter controls how requests are cached during request processing. The possible integer values are as follows:
|
Integer (0 - 6) This can be |
|
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
|
|
|
This parameter identifies additional restore command options. These options typically are prefixed with a dash (similar to command line options). Some options can override parameters for the Source/Destination. Some typical restore options are a follows: Rename certain files: -rest_renaming <renamerule> Use certain transcoders: -tr_names <transcoder_list> Restored format: -tr_restore_format <format> Generate a metadata file on restore: -rm |
String (0 - 768 characters) You can leave this field empty. |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-18 multipleRestoreObject() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
Integer (1 - 10,000,000) |
The following are typical DIVArchive multipleRestoreObject() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
More than one object with the specified name exists in the DIVArchive or DIVAnet database.
The Source/Destination name provided does not exist in DIVArchive.
There are no available instances of the object. For example, this could possibly occur because a required tape was ejected from a tape library.
The specified object instance does not exist in DIVArchive or DIVAnet.
One or more object instances are currently offline and cannot be processed.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST multipleRestoreObject() request:
<p:multipleRestoreObject xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1="http://model.api.ws.diva.fpdigital.com/xsd">
<p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode>
<p:objectName>PREPROD_July_Edits4</p:objectName>
<p:objectCategory>PROD</p:objectCategory>
<p:destinations>
<p1:destination>POST2</p1:destination>
<p1:filePathRoot>content</p1:filePathRoot>
</p:destinations>
<p:destinations>
<p1:destination>POST3</p1:destination>
<p1:filePathRoot></p1:filePathRoot>
</p:destinations>
<p:qualityOfService>0</p:qualityOfService>
<p:priorityLevel></p:priorityLevel>
<p:restoreOptions></p:restoreOptions>
</p:multipleRestoreObject>
The following is an example of a REST response for a multipleRestoreObject() request:
<p:multipleRestoreObjectResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:multipleRestoreObjectResponse>
partialRestore()This request enables restoring a portion of an object within DIVArchive to a Source/Destination (such as FTP or CIFS). The caller can define these portions by supplying byte offset ranges, timecode ranges, DPX frame ranges, or entire subdirectories and files. Optionally, the caller can select a specific DIVArchive object instance for the read. The call returns a request ID if the request is created successfully. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in both DIVArchive and DIVAnet.
DIVArchive supports the following major partialRestore() request types:
This type of Partial File Restore request extracts a range of bytes from an archived file into a target file. You can supply multiple ranges. You can determine the name of the target file. You can also extract from multiple source files. You cannot extract from multiple source files into one target file.
This type of Partial File Restore request extracts a portion of a media clip using timecode start and end values. You can determine the name of the target file to place the resulting media segment. You specify a timecode range, and specify the target media format.
This type of Partial File Restore request extracts a range of files based on file order (for example, extract all files from the fifth to the twentieth file in the archive). The archived files must be archived in a particular order.
This type of Partial File Restore request extracts entire subdirectories and files of an archived object, using the original file and folder names that are part of the archive. Recursive folder extraction is supported.
The following is a list of partialRestore() request input parameters:
Table 4-19 partialRestore() Request Input Parameters
| Section | Parameter | Description | Data Type and Default |
|---|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (0 - 96 characters) You can leave this field empty. |
|
|
|
Specifying a value for this parameter enables the caller to select a specific object instance to delete. If DIVAnet is used, pass the DIVAnet object instance ID, which is unique among all sites. |
Integer (0 - 100000).If this value is |
|
|
fileList |
This section identifies a list of files and file offsets, or a list of subdirectories or files within the archived object to restore. The various sections within |
Maximum entries are configured in DIVArchive. This field is required. |
|
|
|
This parameter identifies a DIVArchive Source/Destination name representing a server or disk (such as FTP or CIFS). The archived object files are restored to this destination. |
String (1 - 96 characters) This field is required. |
|
|
|
This parameter identifies the top-level directory within the Source/Destination where files should be restored. If this value is not specified, the default stored in the |
String (0 - 4000 characters) This can be empty. |
|
|
|
This parameter controls how requests are cached during request processing. The possible integer values are as follows:
Partial File Restore requests do not support NearLine QOS. |
Integer (0 - 4) This can be |
|
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
|
|
|
This parameter identifies additional restore command options. These options typically are prefixed with a dash (similar to command line options). Some options can override parameters for the Source/Destination. Some typical restore options are a follows: Rename certain files: -rest_renaming <renamerule> Use certain transcoders: -tr_names <transcoder_list> Restored format: -tr_restore_format <format> Generate a metadata file on restore: -rm |
String (0 - 768 characters) You can leave this field empty. |
|
|
|
This parameter identifies a numeric code that indicates either the type of Partial File Restore to use (for example, file and folder partial file restore), or a particular media format. Selecting a media format implies a timecode based Partial File Restore. Partial File Restore Type:
Partial File Restore Formats (implies Timecode Partial File Restore):
|
Integer ( This field is required. |
<fileList>The following sections describe how to create and specify Partial File Restore selections for the major types of Partial File Restores (see Major Partial File Restore Request Types).
You set the <format> parameter value to 0 in the request to extract byte ranges. The following table specifies the parameters you must provide in the <fileList> section:
Table 4-20 Byte Offset Partial File Restore <fileList> Parameters
| Section | Parameter | Description | Data Type and Default |
|---|---|---|---|
|
|
This parameter identifies the file name to assign to the output of the Partial File Restore. Relative (or absolute) paths in the file name are not allowed. |
String (1 - 4000) This field is required. |
|
|
|
This section identifies the byte ranges of the file to restore. The number -1 defaults to the total number of bytes in the file. There is no enclosing tag for all of the offsets in this section. <offsetVector> <byteBegin>0</byteBegin> <byteEnd>20</byteEnd> <posType>1</posType> </offsetVector> <offsetVector> <byteBegin>40</byteBegin> <byteEnd>-1</byteEnd> <posType>1</posType> </offsetVector> |
||
|
|
|
This parameter identifies the starting byte in the range. The first byte starts at zero. |
Integer This can be |
|
|
|
This parameter identifies the ending byte in the range. The last byte is indicated with a |
Integer This can be |
|
|
|
This parameter identifies the type of offset being utilized. Set this value to |
Integer (1 - 2) This field is required. |
|
|
This parameter identifies the source file name within the archived object. |
String (1 - 4000) This field is required. |
You set the <format> parameter in the request to the desired format (or use autodetect) to extract time regions from media files. The following table specifies the parameters you must provide in the <fileList> section:
Table 4-21 Timecode Partial File Restore <fileList> Parameters
| Section | Parameter | Description | Data Type and Default |
|---|---|---|---|
|
|
This parameter identifies the file name to assign to the output of the Partial File Restore. Relative (or absolute) paths in the file name are not allowed. If the Partial File Restore results in multiple files being generated (for example, audio files), DIVArchive uses the |
String (1 - 4000) This field is required. |
|
|
|
This section identifies the timecode range to restore. The number -1 defaults to the total number of bytes in the file. There is no enclosing tag for all of the offsets in this section. <offsetVector> <timeCodeBegin>00:00:00:00</timeCodeBegin> <timeCodeEnd>00:00:10:00 </timeCodeEnd> <posType>2</posType> </offsetVector> <offsetVector> <timeCodeBegin>00:00:20:00</timeCodeBegin> <timeCodeEnd>99:99:99:99</timeCodeEnd> <posType>2</posType> </offsetVector> |
||
|
|
|
This parameter identifies the SMPTE timecode value marking the start of the portion to extract, in the format |
String ( This field is required. |
|
|
|
This parameter identifies the SMPTE timecode value marking the end of the portion to extract, in the format |
String ( This field is required. |
|
|
|
This parameter identifies the type of offset being utilized. Set this value to |
Integer (1 - 2) This field is required. |
|
|
This parameter identifies the source file name within the archived object. |
String (1 - 4000) This field is required. |
You set the <format> parameter value in the request to 12 (Files and Folder Partial Restore) to extract entire subdirectories and files. The files are restored with the relative path and file names specified in the archive. For example, a file archived as misc/12-2012/movie.avi would be partially restored to a misc/12-2012 subdirectory with the name movie.avi. There is no renaming option for Files and Folders Partial File Restore.
The following table specifies the parameters you must provide in the <fileList> section:
Table 4-22 Files and Folders Partial Files Restore <fileList> Parameters
| Section | Parameter | Description | Data Type and Default |
|---|---|---|---|
|
|
This section identifies the list of archived files and folders to restore. This section occurs only once within the
<fileList>
<fileFolder>
<fileFolder>media/pt3</fileFolder>
<option>-r</option>
</fileFolder>
</fileList>
<fileList>
<fileFolder>
<fileFolder>media/f.txt</fileFolder>
<option></option>
</fileFolder>
</fileList>
|
Maximum |
|
|
|
|
This parameter identifies the name of the file or folder to restore, including the path (if relevant). When you specify a folder, that folder, and all files in the archive directly within that folder, are restored. To recursively restore all files and folders within the specified folder, use the |
String (1 - 4000) This field is required. |
|
|
|
This parameter identifies an option for the restore. Using |
String (0 - 768) You can leave this field empty. |
|
|
You should not include these two parameters for File and Folder Partial File Restore requests. |
This is optional. |
This type of Partial File Restore is specifically designed for extracting ranges of DPX (Digital Picture Exchange) files. Each DPX file corresponds to a frame in a media clip. DIVArchive allows a range of files to be extracted based on file order. For example, you can extract all files from the fifth to the twentieth file. Each file can represent a frame number in a video or media clip. You set the <format> parameter value in the request to 13 (DPX Partial File Restore) to use DPX Partial File Restore.
To be considered a frame, each file in a DPX object must have a .tiff or .dpx extension. DIVArchive bases the frame number on the order the files were archived. If the first file archived is named MDCLIP_000002.dpx, the assigned frame number is 1 (regardless of the file name). The same rule applies if directories appear in the archive. Directories are often sorted alphanumerically at Source/Destinations. However, you can use the -file_order option when archiving DPX objects to ensure proper ordering.
The following table specifies the parameters you must provide in the <fileList> section:
Table 4-23 DPX Frame Partial File Restore <fileList> Parameters
| Section | Parameter | Description | Data Type and Default |
|---|---|---|---|
|
|
This parameter identifies the frame ranges to restore. This section occurs only once within the <fileList> <range> <startRange>1</startRange> <endRange>10</endRange> </range></fileList><fileList> <range> <startRange>42</startRange> <endRange>-1</endRange> </range></fileList> |
Maximum |
|
|
|
|
This parameter identifies the file order number of the first frame (file) to extract. The first frame starts at |
Integer ( This field is required. |
|
|
|
This parameter identifies the file order number of the last frame (file) to extract. You use |
Integer ( This field is required. |
|
|
You should not include these two parameters for DPX Frame Partial File Restore requests. |
This is optional. |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-24 partialRestore() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
Integer (1 - 10,000,000) |
The following are typical DIVArchive partialRestore() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
More than one object with the specified name exists in the DIVArchive or DIVAnet database.
The Source/Destination name provided does not exist in DIVArchive.
There are no available instances of the object. For example, this could possibly occur because a required tape was ejected from a tape library.
The specified object instance does not exist in DIVArchive or DIVAnet.
One or more object instances are currently offline and cannot be processed.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST Timecode partialRestore() request:
<p:partialRestore xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1="http://model.api.ws.diva.fpdigital.com/xsd">
<p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode>
<p:objectName>PREPROD_July_Edits4</p:objectName>
<p:objectCategory>PROD</p:objectCategory>
<p:instanceID></p:instanceID>
<p:fileList>
<p1:destFile>mediaIntro01.mxf</p1:destFile>
<p1:offsetVector>
<p1:timeCodeBegin>00:00:00:00</p1:timeCodeBegin>
<p1:timeCodeEnd>00:00:10:00</p1:timeCodeEnd>
<p1:posType>2</p1:posType>
</p1:offsetVector>
<p1:sourceFile>mediaFile01.xml</p1:sourceFile>
</p:fileList>
<p:destination>POST2</p:destination>
<p:filesPathRoot>partial/out</p:filePathRoot>
<p:qualityOfService>0</p:qualityOfService>
<p:priorityLevel>50</p:priorityLevel>
<p:restoreOptions></p:restoreOptions>
<p:format>11</p:format>
</p:partialRestore>
The following is an example of a REST response for a Timecode partialRestore() request:
<p:partialRestoreResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:partialRestoreResponse>
transcodeArchive()This request transcodes an existing archived object to a different media format, and then archives the resulting files as a new object in DIVArchive. You can think of this command as a CopyToNew request with transcode. The call returns a request ID if the request is created successfully. You can monitor the progress of the call throughout its lifecycle using the getRequestInfo() call. This request is available in DIVArchive, but not DIVAnet (MultiDIVA mode).
The following is a list of transcodeArchive() request input parameters:
Table 4-25 transcodeArchive() Request Input Parameters
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
|
This parameter identifies the name of the object. This parameter, along with |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the name of the object category. This parameter, along with |
String (1 - 96 characters) This field is required. |
|
|
This parameter identifies the instance ID in DIVArchive, and enables the caller to select the particular object instance to use for the transcode. |
Integer (0 - 1000).If this value is |
|
|
This parameter identifies the name of the new object to create. This object will contain the transcoded files. |
String (1 - 192 characters) This field is required. |
|
|
This parameter identifies the category of the new object to create. This object will contain the transcoded files. |
String (1-96 characters) This field is required. |
|
|
This parameter identifies a DIVArchive media name, and enables the caller to select a particular media for the new object containing the transcoded files. You can also specify a DIVArchive Storage Plan. In this case, DIVArchive will perform SPM processing to determine which media is used for the archive. |
String (0 - 96 characters) This field is required. |
|
|
This parameter identifies an optional string containing information describing the object. |
String (0 - 4000 characters) You can leave this field empty. |
|
|
This parameter identifies additional command options. These options are typically prefixed with a dash (similar to command line options). Some options can override parameters for the Source/Destination. The following options are required top perform the transcode operation: Use certain transcoders: -tr_names <transcoder_list> Transcode format: -tr_archive_format <format> |
String (0 - 768 characters) You can leave this field empty. |
|
|
This parameter controls how requests are cached during request processing. The possible integer values are as follows:
|
Integer (0 - 6) This can be |
|
|
If this value is |
Boolean ( This field is required. |
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-26 transcodeArchive() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
Integer (1 - 10,000,000) |
The following are typical DIVArchive transcodeArchive() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
An object with the name provided does not exist in DIVArchive.
More than one object with the specified name exists in the DIVArchive or DIVAnet database.
The provided tape group does not exist in the target DIVArchive system.
There are no available instances of the object. For example, this could possibly occur because a required tape was ejected from a tape library.
The specified object instance does not exist in DIVArchive or DIVAnet.
One or more object instances are currently offline and cannot be processed.
One or more objects are currently being used and cannot be processed.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST transcodeArchive() request:
<p:transcodeArchive xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd"> <p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode> <p:parentObjectName>PREPROD_July_Edits4</p:parentObjectName> <p:parentObjectCategory>PROD</p:parentObjectCategory> <p:instance>-1</p:instance> <p:objectName>PREPROD_July_Edits4</p:objectName> <p:objectCategory>PRODProxy</p:objectCategory> <p:mediaName>Post4LTO7</p:mediaName> <p:comments>Transcoded version of original (PROD)</p:comments> <p:archiveOptions>-tr_names TRANS_001 -tr_format MXF</p:archiveOptions> <p:qualityOfService>0</p:qualityOfService> <p:bCascadeDelete>false</p:bCascadeDelete> <p:priorityLevel>50</p:priorityLevel> </p:transcodeArchive>
The following is an example of a REST response for a transcodeArchive() request:
<p:transcodeArchiveResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:transcodeArchiveResponse>
transferFiles()This request enables transferring multiple files and directories from a Source/Destination to another Source/Destination without the object being archived in DIVArchive. The call returns a request ID if the request is created successfully. You can monitor the progress of the archive throughout its lifecycle using the getRequestInfo() call. This request is available in DIVArchive, but not DIVAnet (MultiDIVA mode).
The following is a list of transferFiles() request input parameters:
Table 4-27 transferFiles() Request Input Parameters
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter identifies the unique ID associated with the client's session. |
String (1 - 36 characters) This field is required. |
|
source |
This parameter identifies a DIVArchive Source/Destination name representing a server or disk (such as FTP or CIFS). The files are transferred from this location. |
|
|
|
This parameter identifies the top-level directory of files to transfer as an offset from the Source/Destination. |
String (0 - 4000 characters) You can leave this field empty. |
|
|
This parameter identifies the list of files (or wildcard patterns) to be transferred. Paths for the files are relative to the specified <fileNamesList>misc/*</fileNamesList> <fileNamesList>t.mov</fileNamesList> |
String (each file can contain 1 - 400 characters)This field is required. |
|
|
This parameter identifies a DIVArchive Source/Destination name representing a server or disk (such as FTP or CIFS). The files are transferred to this location. |
|
|
|
This parameter identifies the top-level directory where files are transferred to as an offset from the Source/Destination. |
String (0 - 4000 characters) You can leave this field empty. |
|
|
This parameter identifies the initial request priority on a scale of 0 to 100 (100 is the highest priority). The effective priority of the request increases the longer it waits for execution. |
Integer (0 - 100) If you use |
If a response to the request was returned by DIVArchive or DIVAnet, HTTP status code 200 will be returned, and will include the following values:
Table 4-28 transferFiles() Request Returned Values
| Parameter | Description | Data Type and Default |
|---|---|---|
|
|
This parameter is the DIVArchive Status Code for the operation (see the following section). |
Integer (1000 - 1039) |
|
|
This parameter is an ID uniquely identifying the running request. You can monitor the progress of the request using this ID. |
Integer (1 - 10,000,000) |
The following are typical DIVArchive transferFiles() request status codes. See Appendix A for all DIVArchive Status Codes.
The request has been created successfully.
One or more parameters contain data that cannot be parsed correctly.
The provided Source/Destination does not exist in the DIVArchive configuration.
The DIVArchive or DIVAnet system temporarily cannot accept any more requests. You can try the request again later.
This code is returned if the client does not have permission for the request, or the command has been disallowed.
The following is an example of a REST transferFiles() request:
<p:transferFiles xmlns:p="http://interaction.api.ws.diva.fpdigital.com/xsd"> <p:sessionCode>810c85c7-d70c-414e-93a4-655a3e4c89bd</p:sessionCode> <p:source>PROD3</p:source? <p:sourcePathRoot>jul_03_final</p:sourcePathRoot> <p:fileNamesList>ActionPST.avi</p:fileNamesList> <p:fileNamesList>ActionPST.wav</p:fileNamesList> <p:destination>BCAST1</p:destination> <p:destinationPathRoot>wed/allMedia</p:destinationPathRoot> <p:priorityLevel>50</p:priorityLevel> </p:transferFiles>
The following is an example of a REST response for a transferFiles() request:
<p:transferFilesResponse xmlns:p=http://interaction.api.ws.diva.fpdigital.com/xsd xmlns:p1=http://response.model.api.ws.diva.fpdigital.com/xsd>
<p:return>
<p1:divaStatus>1000</p1:divaStatus>
<p1:requestNumber>4905</p1:requestNumber>
</p:return>
</p:transferFilesResponse>