Queue/SaveBatchAttribute

This method saves the batch attributes, including extra batch attributes.

The logon user must have Status change/rollback privileges for the jobTaskOrder, queueStatus, and taskID attributes to be saved.
The logon user must have Priority/Operator change privileges for the QueuePriority, Operator, Station, SkipOperator, or SkipStation attributes to be saved.
The logon user must have Batch attributes change privileges for the BatchDir or PageFile attributes to be saved.

URI

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

The URI for this method includes the following path elements.

Table 1. Path elements for the POST SaveBatchAttribute method
Name	Type	Required?	Description
`{application}`	String	Yes	The name of the application for which the batch attributes are to be saved.

Request content

The request content saves the batch attributes.

Response content

The response return the message and returnCode content.

This method returns one of the following response codes.

Table 2. Response codes for the POST SaveBatchAttribute 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 SaveBatchAttribute method JSON request example

{

   "batchDir": "String content",
   "jobTaskOrder": 2147483647,
   "operationUser": "String content",
   "pageFile": "String content",
   "queueID": 2147483647,
   "queuePriority": 2147483647,
   "queueStatus": "String content",
   "skipOperator": "String content",
   "skipStation": "String content",
   "station": "String content",
   "taskID": "String content",
   "xtraBatchFields": {
      "Count": 2147483647,
      "Fields": [
         {
            "field": "String content",
            "value": "String content"
         }
      ]
   }
}

POST SaveBatchAttribute method XML request example

<BatchAttrSave> 
  <batchDir>String content</batchDir> 
  <jobTaskOrder>2147483647</jobTaskOrder> 
  <operationUser>String content</operationUser> 
  <pageFile>String content</pageFile> 
  <queueID>2147483647</queueID> 
  <queuePriority>2147483647</queuePriority> 
  <queueStatus>String content</queueStatus> 
  <skipOperator>String content</skipOperator> 
  <skipStation>String content</skipStation> 
  <station>String content</station> 
  <taskID>String content</taskID> 
  <xtraBatchFields> 
     <Count>2147483647</Count> 
     <Fields> 
       <XtraBatchField> 
          <field>String content</field> 
          <value>String content</value> 
       </XtraBatchField> 
       <XtraBatchField> 
          <field>String content</field> 
          <value>String content</value> 
       </XtraBatchField> 
     </Fields> 
  </xtraBatchFields> 
</BatchAttrSave>

POST SaveBatchAttribute method JSON response example

{
   "message": "String content",
   "returnCode": 2147483647
}

POST SaveBatchAttribute method XML response example

<ReturnResult> 
  <message>String content</message> 
  <returnCode>2147483647</returnCode> 
</ReturnResult>