Queue/CopyFilesToCache

This method copies files from the batch folder to the cache folder without downloading the files to the client. When files are uploaded or downloaded, they are placed in the cache. This method is used to run rules on data files such as, tm000001.xml and tm00000.cco, for pages that were not downloaded.

If the file is cached and an endpoint is used to retrieve a file from the batch folder, the cached file is returned. If the file is not in the cache, the file is returned from the batch folder and added to the cache. When you are calling an endpoint that adds or updates a batch file, the file is saved to the cache but it is not saved to the batch folder. When the batch is released, all files are copied from the cache and will write over files that are in the batch folder.

The wTmId header value that is returned by the POST method Session/Logon must be in the session header.

URI

http://{IP address}:{Port}/ServicewTM.svc/Queue/CopyFilesToCache/{application}/{queueId}

The URI for this method includes the following path elements.

Table 1. Path elements for the POST CopyFilesToCache method
Name	Type	Required?	Description
`{application}`	String	Yes	The name of the application for which the files are to be copied to the cache folder.
`{queueId}`	String	Yes	The unique identifier that is assigned to the batch.

Request content

The request content is the message body.

Response content

The response for this method contains no content.

This method returns one of the following response codes.

Table 2. Response codes for the POST CopyFilesToCache method
Response Code	Description
200 OK	The request was successful.
400 Bad Request	The request was not understood by the service because of malformed syntax.
401 Unauthorized	The request requires user authentication. If the request included valid credentials, the 401 response indicates that authorization was refused for those credentials.
405 Method Not Allowed	The method that is specified in the `Request-Line` is not allowed for the resource that is identified by the `Request-URI`. The response must include an `Allow` header that contains a list of valid methods for the requested resource.
411 Length Required	The service refuses to accept the request without a defined `Content-Length`. The client can repeat the request if it adds a valid `Content-Length` header field that contains the length of the message body in the request message.
500 Internal Error	An unexpected condition was encountered that prevented the service from fulfilling the request.

POST CopyFilesToCache method JSON request example

["String content"]

POST CopyFilesToCache method XML request example

<ArrayOfstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>tm000001.tif</string>
  <string>tm000001.cco</string>
</ArrayOfstring>