JSON Job Set Statistics

Describes a summary of the statistics for a specific job set entity, including:

• the Job Set and the documents contained in the job set

• metadata properties and sheet and page counts for both the job set and individual documents

• the media types used in the job set and individual media usage for each document.

Structure

The structure consists of an object with the following name/value pairs:

• jobSetId – the job set entity identifier (type of number)

• properties – an array of metadata properties (type of string) of the job set, if it has any

• counts – summary of the number of sheets and pages in the job set, consisting of an object containing the following name/value pairs:

  • sheets – the number of sheets in the job set (type of number)

  • pages – the number of pages in the job set (type of number)

• media – a list of media types used in the documents contained in this job set, consisting of an array of objects each with the following name/value pairs:

  • name – the name of the media (type of string)

  • type – the type of the media (type of string)

  • size – the size of the media, consisting of an object with the following name/value pairs:

  • width – the width of the media (type of string)

  • height – the height of the media (type of string)

  • color – the color of the media (type of string)
  • weight – the weight of the media (type of string)

  • count – the number of pages using the specific media (type of number)

• documents – a list of documents contained in this job set, consisting of an array of objects each with the following name/value pairs:

  • documentId – ID of the document (type of number)

  • contentItemId – ID of the content Item associated with the document (type of number)

  • dataRecordId – ID of the data record associated with the document (type of number)

  • properties – an array of metadata properties (type of string) of the document, if it has any

  • counts – summary of the number of sheets and pages in the document, consisting of an object containing the following name/value pairs:

    • sheets – the number of sheets in the document (type of number)

    • pages – the number of pages in the document (type of number)

  • media – an object with one key/value pair per media type that is used in the document, specifying the number of times that specific media type is used in the document. A media type is referenced by its index (zero based) in the master media list.

Example

The following is an example of this structure:

{
    "jobSetId": 13217206,
    "properties": {
        "metadata": "jobset"
    },
    "counts": {
        "sheets": 100,
        "pages": 100
    },
    "media": [
        {
            "name": "A4",
            "type": "Unspecified",
            "size": {
                "width": "210mm",
                "height": "297mm"
            },
            "color": null,
            "weight": "0g",
            "count": 100
        }
    ],
    "documents": [
        {
            "documentId": 13217931,
            "contentItemId": 1179516,
            "dataRecordId": 2553516,
            "properties": {
                "FirstName": "Norris",
                "LastName": "Schiffman",
                "Phone1": ""
            },
            "counts": {
                "sheets": 1,
                "pages": 1
            },
            "media": {
                "0": 1
            }
        } 
    ]
}