persistAddJob

Description

Accepts an array of tasks, parses it, and creates database records to represent the job. Once a job is created, it is identified by a jobID, and may be run whenever needed using persistRunJob, without having to specify anything other than the jobID.

See here for more details on Persist.

Remarks

Note: Adding a Persist Job to the database does not start it.

Example

Request

{
  "name": "Presort Lists 1 and 2",
  "tasks": [
    {
      "name": "Presort List 1",
      "serviceId": "presort",
      "requestData":
        {
          "addressTable" : "name$List1",
          "presortName" : "List 1 - STD-L",
          "mailClass" : "STANDARD",
          "pieceType" : "LETTER",
          "pcWt" : 0.5,
          "pcThick" : 0.03,
          "origZip" : 14623
        }
    },
    {
      "name": "Presort List 2",
      "serviceId": "presort",
      "requestData":
        {
          "addressTable" : "name$List2",
          "presortName" : "List 2 - FC-F",
          "mailClass" : "FIRST",
          "pieceType" : "FLAT",
          "pcWt" : 2.1,
          "pcThick" : 0.25,
          "pcLength" : 12.5,
          "pcHeight" : 8,
          "origZip" : 14623
        }
    }
  ]
}

Reply

This returns the JobID that is stored in the Jobs database.

{
  "jobID": 1
}

Request Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "description":"Create a Job comprised of an ordered list of Tasks.",
  "type":"object",
  "required":[
    "tasks"
  ],
  "additionalProperties":false,
  "properties":{
    "name":{
      "title":"Name",
      "description":"Specifies the Job record Name.",
      "type":"string",
      "minLength":1
    },
    "tasks":{
      "type":"array",
      "items":{
        "oneOf":[
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "addressTableCreateFromDatabase"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"addressTableCreateFromDatabase-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "addressTableCreateFromPackage"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"addressTableCreateFromPackage-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "addressTableCreateFromTemplate"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"addressTableCreateFromTemplate-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "addressTableCreatePackage"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"addressTableCreatePackage-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "addressTableDelete"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"addressTableDelete-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "addressTableExport"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"addressTableExport-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "addressTableImport"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"addressTableImport-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "addressTableModify"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"addressTableModify-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "callResource-addressTables",
                  "callResource-companies",
                  "callResource-permits",
                  "callResource-publications"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"callResource-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "containerTags"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"containerTags-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "dmsJob"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"dmsJob-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "encodeRecord"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"encodeRecord-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "encodeTable"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"encodeTable-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "eSubmission"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"eSubmission-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "installReferenceData"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"installReferenceData-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "mailDat"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"mailDat-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "manifestReport"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"manifestReport-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "modifyPresorted"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"modifyPresorted-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "postageStatement"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"postageStatement-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "presort"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"presort-req.json"
              }
            }
          },
          {
            "type":"object",
            "required":[
              "serviceId",
              "requestData"
            ],
            "properties":{
              "serviceId":{
                "title":"Service ID",
                "description":"Identifies the task's service.",
                "type":"string",
                "enum":[
                  "qualificationReport"
                ]
              },
              "requestData":{
                "title":"Request Data",
                "description":"Task request parameters, encoded as a JSON string.",
                "$ref":"qualificationReport-req.json"
              }
            }
          }
        ]
      }
    }
  }
}

Reply Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"object",
  "required":[
    "jobID"
  ],
  "additionalProperties":false,
  "properties":{
    "jobID":{
      "title":"Job ID",
      "description":"Identifies the newly created Job record.",
      "type":"integer"
    }
  }
}