Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 3: Line 3:
 
This page contains information about how the data files for Contact History export jobs are formatted and structured.  
 
This page contains information about how the data files for Contact History export jobs are formatted and structured.  
  
The exported data files are formatted in {{#Widget:ExtLink|link=http://jsonlines.org|displaytext=JSON (JavaScript Object Notation) Lines format}}. In this type of format, each line in the file corresponds to one interaction or contacts attribute, displayed as a '''key:value''' pair.  
+
The exported data files are formatted in {{#Widget:ExtLink|link=http://jsonlines.org|displaytext=JSON (JavaScript Object Notation) Lines format}}. In this type of format, each line in the file corresponds to one interaction or contacts attribute, represented as a JSON object with keys and values.  
  
 
For example, an entry in a contact export might look like this:
 
For example, an entry in a contact export might look like this:
Line 34: Line 34:
 
<source lang="text">
 
<source lang="text">
 
{
 
{
"definitions" : { },
+
  "definitions": {},
"$schema" : "http://json-schema.org/draft-07/schema#",
+
  "$schema": "http://json-schema.org/draft-07/schema#",
"$id" : "http://genesys.com/gdps/schema/9.0.001.07/interaction.json",
+
  "$id": "http://genesys.com/gdps/schema/9.0.001.07/interaction.json",
"type" : "object",
+
  "type": "object",
"title" : "Interaction schema",
+
  "title": "Interaction schema",
"required" : [ "IXNID" ],
+
  "required": [
"properties" : {
+
    "IXNID"
"IXNID" : {
+
  ],
"$id" : "#/properties/IXNID",
+
  "properties": {
"type" : "string",
+
    "IXNID": {
"title" : "The IXNID Schema",
+
      "$id": "#/properties/IXNID",
"default" : "16 characters",
+
      "type": "string",
"examples" : [ {
+
      "title": "The IXNID Schema",
"example of interaction Id" : "17PKMJG4K82TRGG1"
+
      "default": "16 characters",
}, {
+
      "examples": [
"Length" : "16 characters"
+
        {
} ]
+
          "example of interaction Id": "17PKMJG4K82TRGG1"
},
+
        },
"STATUS" : {
+
        {
"$id" : "#/properties/STATUS",
+
          "Length": "16 characters"
"type" : "integer",
+
        }
"title" : "The STATUS Schema",
+
      ]
"default" : "null",
+
    },
"examples" : [ {
+
    "STATUS": {
"values" : "0: New, 1: Pending, 2: InProcess, 3: Stopped"
+
      "$id": "#/properties/STATUS",
}, {
+
      "type": "integer",
"definition" : "Interaction state available through a set of enums"
+
      "title": "The STATUS Schema",
} ]
+
      "default": "null",
},
+
      "examples": [
"ENTITYTYPEID" : {
+
        {
"$id" : "#/properties/ENTITYTYPEID",
+
          "values": "0: New, 1: Pending, 2: InProcess, 3: Stopped"
"type" : "integer",
+
        },
"title" : "The ENTITYTYPEID Schema",
+
        {
"default" : "null",
+
          "definition": "Interaction state available through a set of enums"
"examples" : [ {
+
        }
"values" : "0: EmailIn, 1: EmailOut, 2: Chat, 3: PhoneCall, 5: Callback, 6: CoBrowse, 7: Interaction"
+
      ]
}, {
+
    },
"definition" : "Interaction type available through a set of enums"
+
    "ENTITYTYPEID": {
} ]
+
      "$id": "#/properties/ENTITYTYPEID",
},
+
      "type": "integer",
"MEDIATYPEID" : {
+
      "title": "The ENTITYTYPEID Schema",
"$id" : "#/properties/MEDIATYPEID",
+
      "default": "null",
"type" : "string",
+
      "examples": [
"title" : "The MEDIATYPEID Schema",
+
        {
"default" : "",
+
          "values": "0: EmailIn, 1: EmailOut, 2: Chat, 3: PhoneCall, 5: Callback, 6: CoBrowse, 7: Interaction"
"examples" : [ ]
+
        },
},
+
        {
"TYPEID" : {
+
          "definition": "Interaction type available through a set of enums"
"$id" : "#/properties/TYPEID",
+
        }
"type" : "string",
+
      ]
"title" : "The TYPEID Schema",
+
    },
"default" : "",
+
    "MEDIATYPEID": {
"examples" : [ ]
+
      "$id": "#/properties/MEDIATYPEID",
},
+
      "type": "string",
"SUBTYPEID" : {
+
      "title": "The MEDIATYPEID Schema",
"$id" : "#/properties/SUBTYPEID",
+
      "default": "",
"type" : "string",
+
      "examples": []
"title" : "The SUBTYPEID Schema",
+
    },
"default" : "",
+
    "TYPEID": {
"examples" : [ ]
+
      "$id": "#/properties/TYPEID",
},
+
      "type": "string",
"EXTERNALID" : {
+
      "title": "The TYPEID Schema",
"$id" : "#/properties/EXTERNALID",
+
      "default": "",
"type" : "string",
+
      "examples": []
"title" : "The EXTERNALID Schema",
+
    },
"default" : "",
+
    "SUBTYPEID": {
"examples" : [ ]
+
      "$id": "#/properties/SUBTYPEID",
},
+
      "type": "string",
"OWNERID" : {
+
      "title": "The SUBTYPEID Schema",
"$id" : "#/properties/OWNERID",
+
      "default": "",
"type" : "integer",
+
      "examples": []
"title" : "The OWNERID Schema",
+
    },
"default" : "",
+
    "EXTERNALID": {
"examples" : [ ]
+
      "$id": "#/properties/EXTERNALID",
},
+
      "type": "string",
"CONTACTID" : {
+
      "title": "The EXTERNALID Schema",
"$id" : "#/properties/CONTACTID",
+
      "default": "",
"type" : "string",
+
      "examples": []
"title" : "The CONTACTID Schema",
+
    },
"default" : "",
+
    "OWNERID": {
"examples" : [ ]
+
      "$id": "#/properties/OWNERID",
},
+
      "type": "integer",
"PARENTID" : {
+
      "title": "The OWNERID Schema",
"$id" : "#/properties/PARENTID",
+
      "default": "",
"type" : "string",
+
      "examples": []
"title" : "The PARENTID Schema",
+
    },
"default" : "",
+
    "CONTACTID": {
"examples" : [ ]
+
      "$id": "#/properties/CONTACTID",
},
+
      "type": "string",
"STARTDATE" : {
+
      "title": "The CONTACTID Schema",
"$id" : "#/properties/STARTDATE",
+
      "default": "",
"type" : "string",
+
      "examples": []
"title" : "The STARTDATE Schema",
+
    },
"default" : "Date and time of creation",
+
    "PARENTID": {
"examples" : [ {
+
      "$id": "#/properties/PARENTID",
"StartDate" : "2010-04-30T12:03:30.133Z"
+
      "type": "string",
}, {
+
      "title": "The PARENTID Schema",
"definition" : "Date and time in ISO 8601 standard when interaction starts"
+
      "default": "",
} ]
+
      "examples": []
},
+
    },
"MODIFIEDDATE" : {
+
    "STARTDATE": {
"$id" : "#/properties/MODIFIEDDATE",
+
      "$id": "#/properties/STARTDATE",
"type" : "string",
+
      "type": "string",
"title" : "The MODIFIEDDATE Schema",
+
      "title": "The STARTDATE Schema",
"default" : "null",
+
      "default": "Date and time of creation",
"examples" : [ {
+
      "examples": [
"ModifiedDate" : "2010-04-30T12:03:30.133Z"
+
        {
}, {
+
          "StartDate": "2010-04-30T12:03:30.133Z"
"definition" : "Date and time in ISO 8601 standard when interaction is updated"
+
        },
} ]
+
        {
},
+
          "definition": "Date and time in ISO 8601 standard when interaction starts"
"ENDDATE" : {
+
        }
"$id" : "#/properties/ENDDATE",
+
      ]
"type" : "string",
+
    },
"title" : "The ENDDATE Schema",
+
    "MODIFIEDDATE": {
"default" : "null",
+
      "$id": "#/properties/MODIFIEDDATE",
"examples" : [ {
+
      "type": "string",
"EndDate" : "2010-04-30T12:03:30.133Z"
+
      "title": "The MODIFIEDDATE Schema",
}, {
+
      "default": "null",
"definition" : "Date and time in ISO 8601 when interaction is stopped"
+
      "examples": [
} ]
+
        {
},
+
          "ModifiedDate": "2010-04-30T12:03:30.133Z"
"THREADID" : {
+
        },
"$id" : "#/properties/THREADID",
+
        {
"type" : "string",
+
          "definition": "Date and time in ISO 8601 standard when interaction is updated"
"title" : "The THREADID Schema",
+
        }
"default" : "",
+
      ]
"examples" : [ ]
+
    },
},
+
    "ENDDATE": {
"CATEGORYID" : {
+
      "$id": "#/properties/ENDDATE",
"$id" : "#/properties/CATEGORYID",
+
      "type": "string",
"type" : "string",
+
      "title": "The ENDDATE Schema",
"title" : "The CATEGORYID Schema",
+
      "default": "null",
"default" : "",
+
      "examples": [
"examples" : [ ]
+
        {
},
+
          "EndDate": "2010-04-30T12:03:30.133Z"
"TIMESHIFT" : {
+
        },
"$id" : "#/properties/TIMESHIFT",
+
        {
"type" : "integer",
+
          "definition": "Date and time in ISO 8601 when interaction is stopped"
"title" : "The TIMESHIFT Schema",
+
        }
"default" : "",
+
      ]
"examples" : [ ]
+
    },
},
+
    "THREADID": {
"SUBJECT" : {
+
      "$id": "#/properties/THREADID",
"$id" : "#/properties/SUBJECT",
+
      "type": "string",
"type" : "string",
+
      "title": "The THREADID Schema",
"title" : "The SUBJECT Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "CATEGORYID": {
"TEXT" : {
+
      "$id": "#/properties/CATEGORYID",
"$id" : "#/properties/TEXT",
+
      "type": "string",
"type" : "string",
+
      "title": "The CATEGORYID Schema",
"title" : "The TEXT Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "TIMESHIFT": {
"STRUCTUREDTEXT" : {
+
      "$id": "#/properties/TIMESHIFT",
"$id" : "#/properties/STRUCTUREDTEXT",
+
      "type": "integer",
"type" : "string",
+
      "title": "The TIMESHIFT Schema",
"title" : "The STRUCTUREDTEXT Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "SUBJECT": {
"STRUCTTEXTMIMETYPE" : {
+
      "$id": "#/properties/SUBJECT",
"$id" : "#/properties/STRUCTTEXTMIMETYPE",
+
      "type": "string",
"type" : "string",
+
      "title": "The SUBJECT Schema",
"title" : "The STRUCTTEXTMIMETYPE Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "TEXT": {
"THECOMMENT" : {
+
      "$id": "#/properties/TEXT",
"$id" : "#/properties/THECOMMENT",
+
      "type": "string",
"type" : "string",
+
      "title": "The TEXT Schema",
"title" : "The THECOMMENT Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "STRUCTUREDTEXT": {
"TENANTID" : {
+
      "$id": "#/properties/STRUCTUREDTEXT",
"$id" : "#/properties/TENANTID",
+
      "type": "string",
"type" : "integer",
+
      "title": "The STRUCTUREDTEXT Schema",
"title" : "The TENANTID Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "STRUCTTEXTMIMETYPE": {
"SUBTENANTID" : {
+
      "$id": "#/properties/STRUCTTEXTMIMETYPE",
"$id" : "#/properties/SUBTENANTID",
+
      "type": "string",
"type" : "integer",
+
      "title": "The STRUCTTEXTMIMETYPE Schema",
"title" : "The SUBTENANTID Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "THECOMMENT": {
"THREADHASH" : {
+
      "$id": "#/properties/THECOMMENT",
"$id" : "#/properties/THREADHASH",
+
      "type": "string",
"type" : "integer",
+
      "title": "The THECOMMENT Schema",
"title" : "The THREADHASH Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "TENANTID": {
"CANBEPARENT" : {
+
      "$id": "#/properties/TENANTID",
"$id" : "#/properties/CANBEPARENT",
+
      "type": "integer",
"type" : "integer",
+
      "title": "The TENANTID Schema",
"title" : "The CANBEPARENT Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "SUBTENANTID": {
"CREATORAPPID" : {
+
      "$id": "#/properties/SUBTENANTID",
"$id" : "#/properties/CREATORAPPID",
+
      "type": "integer",
"type" : "integer",
+
      "title": "The SUBTENANTID Schema",
"title" : "The CREATORAPPID Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "THREADHASH": {
"QUEUENAME" : {
+
      "$id": "#/properties/THREADHASH",
"$id" : "#/properties/QUEUENAME",
+
      "type": "integer",
"type" : "string",
+
      "title": "The THREADHASH Schema",
"title" : "The QUEUENAME Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "CANBEPARENT": {
"ALLATTRIBUTES" : {
+
      "$id": "#/properties/CANBEPARENT",
"$id" : "#/properties/ALLATTRIBUTES",
+
      "type": "integer",
"type" : "object",
+
      "title": "The CANBEPARENT Schema",
"title" : "The ALLATTRIBUTES Schema",
+
      "default": "",
"default" : "null",
+
      "examples": []
"examples" : [ {
+
    },
"example of AllAttributes data" : "\"AllAttributes\":{\"LastName\":\"WALLACE\",\"RStrategyDBID\":\"252\",\"RVQDBID\":\",\"ServiceObjective\":0,\"IWAttachedDataInformation\":{\"DispositionCodeValues\":\"Callback Scheduled\"}}\""
+
    "CREATORAPPID": {
}, {
+
      "$id": "#/properties/CREATORAPPID",
"definition" : "Userdata key/value pairs"
+
      "type": "integer",
}, {
+
      "title": "The CREATORAPPID Schema",
"format" : "{\"<key>\": <data>} where key is a string and data either a string, an integer or another valid json object. Format allows nested structures."
+
      "default": "",
} ]
+
      "examples": []
},
+
    },
"STRATTRIBUTE1" : {
+
    "QUEUENAME": {
"$id" : "#/properties/STRATTRIBUTE1",
+
      "$id": "#/properties/QUEUENAME",
"type" : "string",
+
      "type": "string",
"title" : "The STRATTRIBUTE1 Schema",
+
      "title": "The QUEUENAME Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"STRATTRIBUTE2" : {
+
    "ALLATTRIBUTES": {
"$id" : "#/properties/STRATTRIBUTE2",
+
      "$id": "#/properties/ALLATTRIBUTES",
"type" : "string",
+
      "type": "object",
"title" : "The STRATTRIBUTE2 Schema",
+
      "title": "The ALLATTRIBUTES Schema",
"default" : "",
+
      "default": "null",
"examples" : [ ]
+
      "examples": [
},
+
        {
"STRATTRIBUTE3" : {
+
          "example of AllAttributes data": "\"AllAttributes\":{\"LastName\":\"WALLACE\",\"RStrategyDBID\":\"252\",\"RVQDBID\":\",\"ServiceObjective\":0,\"IWAttachedDataInformation\":{\"DispositionCodeValues\":\"Callback Scheduled\"}}\""
"$id" : "#/properties/STRATTRIBUTE3",
+
        },
"type" : "string",
+
        {
"title" : "The STRATTRIBUTE3 Schema",
+
          "definition": "Userdata key/value pairs"
"default" : "",
+
        },
"examples" : [ ]
+
        {
},
+
          "format": "{\"<key>\": <data>} where key is a string and data either a string, an integer or another valid json object. Format allows nested structures."
"STRATTRIBUTE4" : {
+
        }
"$id" : "#/properties/STRATTRIBUTE4",
+
      ]
"type" : "string",
+
    },
"title" : "The STRATTRIBUTE4 Schema",
+
    "STRATTRIBUTE1": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE1",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE1 Schema",
"STRATTRIBUTE5" : {
+
      "default": "",
"$id" : "#/properties/STRATTRIBUTE5",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The STRATTRIBUTE5 Schema",
+
    "STRATTRIBUTE2": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE2",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE2 Schema",
"STRATTRIBUTE6" : {
+
      "default": "",
"$id" : "#/properties/STRATTRIBUTE6",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The STRATTRIBUTE6 Schema",
+
    "STRATTRIBUTE3": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE3",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE3 Schema",
"STRATTRIBUTE7" : {
+
      "default": "",
"$id" : "#/properties/STRATTRIBUTE7",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The STRATTRIBUTE7 Schema",
+
    "STRATTRIBUTE4": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE4",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE4 Schema",
"STRATTRIBUTE8" : {
+
      "default": "",
"$id" : "#/properties/STRATTRIBUTE8",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The STRATTRIBUTE8 Schema",
+
    "STRATTRIBUTE5": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE5",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE5 Schema",
"STRATTRIBUTE9" : {
+
      "default": "",
"$id" : "#/properties/STRATTRIBUTE9",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The STRATTRIBUTE9 Schema",
+
    "STRATTRIBUTE6": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE6",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE6 Schema",
"STRATTRIBUTE10" : {
+
      "default": "",
"$id" : "#/properties/STRATTRIBUTE10",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The STRATTRIBUTE10 Schema",
+
    "STRATTRIBUTE7": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE7",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE7 Schema",
"INTATTRIBUTE1" : {
+
      "default": "",
"$id" : "#/properties/INTATTRIBUTE1",
+
      "examples": []
"type" : "integer",
+
    },
"title" : "The INTATTRIBUTE1 Schema",
+
    "STRATTRIBUTE8": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE8",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE8 Schema",
"INTATTRIBUTE2" : {
+
      "default": "",
"$id" : "#/properties/INTATTRIBUTE2",
+
      "examples": []
"type" : "integer",
+
    },
"title" : "The INTATTRIBUTE2 Schema",
+
    "STRATTRIBUTE9": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE9",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE9 Schema",
"INTATTRIBUTE3" : {
+
      "default": "",
"$id" : "#/properties/INTATTRIBUTE3",
+
      "examples": []
"type" : "integer",
+
    },
"title" : "The INTATTRIBUTE3 Schema",
+
    "STRATTRIBUTE10": {
"default" : "",
+
      "$id": "#/properties/STRATTRIBUTE10",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STRATTRIBUTE10 Schema",
"INTATTRIBUTE4" : {
+
      "default": "",
"$id" : "#/properties/INTATTRIBUTE4",
+
      "examples": []
"type" : "integer",
+
    },
"title" : "The INTATTRIBUTE4 Schema",
+
    "INTATTRIBUTE1": {
"default" : "",
+
      "$id": "#/properties/INTATTRIBUTE1",
"examples" : [ ]
+
      "type": "integer",
},
+
      "title": "The INTATTRIBUTE1 Schema",
"INTATTRIBUTE5" : {
+
      "default": "",
"$id" : "#/properties/INTATTRIBUTE5",
+
      "examples": []
"type" : "integer",
+
    },
"title" : "The INTATTRIBUTE5 Schema",
+
    "INTATTRIBUTE2": {
"default" : "",
+
      "$id": "#/properties/INTATTRIBUTE2",
"examples" : [ ]
+
      "type": "integer",
},
+
      "title": "The INTATTRIBUTE2 Schema",
"ISSPAM" : {
+
      "default": "",
"$id" : "#/properties/ISSPAM",
+
      "examples": []
"type" : "integer",
+
    },
"title" : "The ISSPAM Schema",
+
    "INTATTRIBUTE3": {
"default" : "",
+
      "$id": "#/properties/INTATTRIBUTE3",
"examples" : [ ]
+
      "type": "integer",
},
+
      "title": "The INTATTRIBUTE3 Schema",
"WEBSAFEEMAILSTATUS" : {
+
      "default": "",
"$id" : "#/properties/WEBSAFEEMAILSTATUS",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The WEBSAFEEMAILSTATUS Schema",
+
    "INTATTRIBUTE4": {
"default" : "",
+
      "$id": "#/properties/INTATTRIBUTE4",
"examples" : [ ]
+
      "type": "integer",
},
+
      "title": "The INTATTRIBUTE4 Schema",
"ISCATEGORYAPPROVED" : {
+
      "default": "",
"$id" : "#/properties/ISCATEGORYAPPROVED",
+
      "examples": []
"type" : "integer",
+
    },
"title" : "The ISCATEGORYAPPROVED Schema",
+
    "INTATTRIBUTE5": {
"default" : "",
+
      "$id": "#/properties/INTATTRIBUTE5",
"examples" : [ ]
+
      "type": "integer",
},
+
      "title": "The INTATTRIBUTE5 Schema",
"STOPPEDREASON" : {
+
      "default": "",
"$id" : "#/properties/STOPPEDREASON",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The STOPPEDREASON Schema",
+
    "ISSPAM": {
"default" : "",
+
      "$id": "#/properties/ISSPAM",
"examples" : [ ]
+
      "type": "integer",
},
+
      "title": "The ISSPAM Schema",
"LANG" : {
+
      "default": "",
"$id" : "#/properties/LANG",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The LANG Schema",
+
    "WEBSAFEEMAILSTATUS": {
"default" : "",
+
      "$id": "#/properties/WEBSAFEEMAILSTATUS",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The WEBSAFEEMAILSTATUS Schema",
"FROMADDRESS" : {
+
      "default": "",
"$id" : "#/properties/FROMADDRESS",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The FROMADDRESS Schema",
+
    "ISCATEGORYAPPROVED": {
"default" : "",
+
      "$id": "#/properties/ISCATEGORYAPPROVED",
"examples" : [ ]
+
      "type": "integer",
},
+
      "title": "The ISCATEGORYAPPROVED Schema",
"FROMPERSONAL" : {
+
      "default": "",
"$id" : "#/properties/FROMPERSONAL",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The FROMPERSONAL Schema",
+
    "STOPPEDREASON": {
"default" : "",
+
      "$id": "#/properties/STOPPEDREASON",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STOPPEDREASON Schema",
"REPLYTOADDRESS" : {
+
      "default": "",
"$id" : "#/properties/REPLYTOADDRESS",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The REPLYTOADDRESS Schema",
+
    "LANG": {
"default" : "",
+
      "$id": "#/properties/LANG",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The LANG Schema",
"TOADDRESSES" : {
+
      "default": "",
"$id" : "#/properties/TOADDRESSES",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The TOADDRESSES Schema",
+
    "FROMADDRESS": {
"default" : "",
+
      "$id": "#/properties/FROMADDRESS",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The FROMADDRESS Schema",
"CCADDRESSES" : {
+
      "default": "",
"$id" : "#/properties/CCADDRESSES",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The CCADDRESSES Schema",
+
    "FROMPERSONAL": {
"default" : "",
+
      "$id": "#/properties/FROMPERSONAL",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The FROMPERSONAL Schema",
"BCCADDRESSES" : {
+
      "default": "",
"$id" : "#/properties/BCCADDRESSES",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The BCCADDRESSES Schema",
+
    "REPLYTOADDRESS": {
"default" : "",
+
      "$id": "#/properties/REPLYTOADDRESS",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The REPLYTOADDRESS Schema",
"SENTDATE" : {
+
      "default": "",
"$id" : "#/properties/SENTDATE",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The SENTDATE Schema",
+
    "TOADDRESSES": {
"default" : "null",
+
      "$id": "#/properties/TOADDRESSES",
"examples" : [ {
+
      "type": "string",
"SentDate" : "2010-04-30T12:03:30.133Z"
+
      "title": "The TOADDRESSES Schema",
}, {
+
      "default": "",
"definition" : "Date and time in ISO 8601 standard"
+
      "examples": []
} ]
+
    },
},
+
    "CCADDRESSES": {
"MAILBOX" : {
+
      "$id": "#/properties/CCADDRESSES",
"$id" : "#/properties/MAILBOX",
+
      "type": "string",
"type" : "string",
+
      "title": "The CCADDRESSES Schema",
"title" : "The MAILBOX Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "BCCADDRESSES": {
"WHICHRULEMATCHED" : {
+
      "$id": "#/properties/BCCADDRESSES",
"$id" : "#/properties/WHICHRULEMATCHED",
+
      "type": "string",
"type" : "string",
+
      "title": "The BCCADDRESSES Schema",
"title" : "The WHICHRULEMATCHED Schema",
+
      "default": "",
"default" : "",
+
      "examples": []
"examples" : [ ]
+
    },
},
+
    "SENTDATE": {
"EMAILOUTID" : {
+
      "$id": "#/properties/SENTDATE",
"$id" : "#/properties/EMAILOUTID",
+
      "type": "string",
"type" : "string",
+
      "title": "The SENTDATE Schema",
"title" : "The EMAILOUTID Schema",
+
      "default": "null",
"default" : "",
+
      "examples": [
"examples" : [ ]
+
        {
},
+
          "SentDate": "2010-04-30T12:03:30.133Z"
"HEADER" : {
+
        },
"$id" : "#/properties/HEADER",
+
        {
"type" : "string",
+
          "definition": "Date and time in ISO 8601 standard"
"title" : "The HEADER Schema",
+
        }
"default" : "null",
+
      ]
"examples" : [ {
+
    },
"definition" : "Encoded mail header in Binary64 format"
+
    "MAILBOX": {
} ]
+
      "$id": "#/properties/MAILBOX",
},
+
      "type": "string",
"FromAddressEmailOut" : {
+
      "title": "The MAILBOX Schema",
"$id" : "#/properties/FromAddressEmailOut",
+
      "default": "",
"type" : "string",
+
      "examples": []
"title" : "The FromAddressEmailOut Schema",
+
    },
"default" : "",
+
    "WHICHRULEMATCHED": {
"examples" : [ ]
+
      "$id": "#/properties/WHICHRULEMATCHED",
},
+
      "type": "string",
"FromPersonalEmailOut" : {
+
      "title": "The WHICHRULEMATCHED Schema",
"$id" : "#/properties/FromPersonalEmailOut",
+
      "default": "",
"type" : "string",
+
      "examples": []
"title" : "The FromPersonalEmailOut Schema",
+
    },
"default" : "",
+
    "EMAILOUTID": {
"examples" : [ ]
+
      "$id": "#/properties/EMAILOUTID",
},
+
      "type": "string",
"ReplyToAddressEmailOut" : {
+
      "title": "The EMAILOUTID Schema",
"$id" : "#/properties/ReplyToAddressEmailOut",
+
      "default": "",
"type" : "string",
+
      "examples": []
"title" : "The ReplyToAddressEmailOut Schema",
+
    },
"default" : "",
+
    "HEADER": {
"examples" : [ ]
+
      "$id": "#/properties/HEADER",
},
+
      "type": "string",
"ToAddressesEmailOut" : {
+
      "title": "The HEADER Schema",
"$id" : "#/properties/ToAddressesEmailOut",
+
      "default": "null",
"type" : "string",
+
      "examples": [
"title" : "The ToAddressesEmailOut Schema",
+
        {
"default" : "",
+
          "definition": "Encoded mail header in Binary64 format"
"examples" : [ ]
+
        }
},
+
      ]
"CcAddressesEmailOut" : {
+
    },
"$id" : "#/properties/CcAddressesEmailOut",
+
    "FromAddressEmailOut": {
"type" : "string",
+
      "$id": "#/properties/FromAddressEmailOut",
"title" : "The CcAddressesEmailOut Schema",
+
      "type": "string",
"default" : "",
+
      "title": "The FromAddressEmailOut Schema",
"examples" : [ ]
+
      "default": "",
},
+
      "examples": []
"BccAddressesEmailOut" : {
+
    },
"$id" : "#/properties/BccAddressesEmailOut",
+
    "FromPersonalEmailOut": {
"type" : "string",
+
      "$id": "#/properties/FromPersonalEmailOut",
"title" : "The BccAddressesEmailOut Schema",
+
      "type": "string",
"default" : "",
+
      "title": "The FromPersonalEmailOut Schema",
"examples" : [ ]
+
      "default": "",
},
+
      "examples": []
"SentDateEmailOut" : {
+
    },
"$id" : "#/properties/SentDateEmailOut",
+
    "ReplyToAddressEmailOut": {
"type" : "string",
+
      "$id": "#/properties/ReplyToAddressEmailOut",
"title" : "The SentDateEmailOut Schema",
+
      "type": "string",
"default" : "null",
+
      "title": "The ReplyToAddressEmailOut Schema",
"examples" : [ {
+
      "default": "",
"SentDateEmailOut" : "2010-04-30T12:03:30.133Z"
+
      "examples": []
}, {
+
    },
"definition" : "Date and time in ISO 8601 standard"
+
    "ToAddressesEmailOut": {
} ]
+
      "$id": "#/properties/ToAddressesEmailOut",
},
+
      "type": "string",
"FORWARD" : {
+
      "title": "The ToAddressesEmailOut Schema",
"$id" : "#/properties/FORWARD",
+
      "default": "",
"type" : "integer",
+
      "examples": []
"title" : "The FORWARD Schema",
+
    },
"default" : "",
+
    "CcAddressesEmailOut": {
"examples" : [ ]
+
      "$id": "#/properties/CcAddressesEmailOut",
},
+
      "type": "string",
"REFERENCEID" : {
+
      "title": "The CcAddressesEmailOut Schema",
"$id" : "#/properties/REFERENCEID",
+
      "default": "",
"type" : "string",
+
      "examples": []
"title" : "The REFERENCEID Schema",
+
    },
"default" : "",
+
    "BccAddressesEmailOut": {
"examples" : [ ]
+
      "$id": "#/properties/BccAddressesEmailOut",
},
+
      "type": "string",
"REVIEWERID" : {
+
      "title": "The BccAddressesEmailOut Schema",
"$id" : "#/properties/REVIEWERID",
+
      "default": "",
"type" : "integer",
+
      "examples": []
"title" : "The REVIEWERID Schema",
+
    },
"default" : "",
+
    "SentDateEmailOut": {
"examples" : [ ]
+
      "$id": "#/properties/SentDateEmailOut",
},
+
      "type": "string",
"STANDARDRESPONSEID" : {
+
      "title": "The SentDateEmailOut Schema",
"$id" : "#/properties/STANDARDRESPONSEID",
+
      "default": "null",
"type" : "string",
+
      "examples": [
"title" : "The STANDARDRESPONSEID Schema",
+
        {
"default" : "",
+
          "SentDateEmailOut": "2010-04-30T12:03:30.133Z"
"examples" : [ ]
+
        },
},
+
        {
"ESTABLISHEDDATE" : {
+
          "definition": "Date and time in ISO 8601 standard"
"$id" : "#/properties/ESTABLISHEDDATE",
+
        }
"type" : "string",
+
      ]
"title" : "The ESTABLISHEDDATE Schema",
+
    },
"default" : "null",
+
    "FORWARD": {
"examples" : [ {
+
      "$id": "#/properties/FORWARD",
"EstablishedDate" : "2010-04-30T12:03:30.133Z"
+
      "type": "integer",
}, {
+
      "title": "The FORWARD Schema",
"definition" : "Date and time in ISO 8601 standard"
+
      "default": "",
} ]
+
      "examples": []
},
+
    },
"RELEASEDDATE" : {
+
    "REFERENCEID": {
"$id" : "#/properties/RELEASEDDATE",
+
      "$id": "#/properties/REFERENCEID",
"type" : "string",
+
      "type": "string",
"title" : "The RELEASEDDATE Schema",
+
      "title": "The REFERENCEID Schema",
"default" : "null",
+
      "default": "",
"examples" : [ {
+
      "examples": []
"definition" : "Date and time in ISO 8601 standard"
+
    },
}, {
+
    "REVIEWERID": {
"ReleasedDate" : "2010-04-30T12:03:30.133Z"
+
      "$id": "#/properties/REVIEWERID",
} ]
+
      "type": "integer",
},
+
      "title": "The REVIEWERID Schema",
"DURATION" : {
+
      "default": "",
"$id" : "#/properties/DURATION",
+
      "examples": []
"type" : "integer",
+
    },
"title" : "The DURATION Schema",
+
    "STANDARDRESPONSEID": {
"default" : "",
+
      "$id": "#/properties/STANDARDRESPONSEID",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The STANDARDRESPONSEID Schema",
"OUTCOME" : {
+
      "default": "",
"$id" : "#/properties/OUTCOME",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The OUTCOME Schema",
+
    "ESTABLISHEDDATE": {
"default" : "",
+
      "$id": "#/properties/ESTABLISHEDDATE",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The ESTABLISHEDDATE Schema",
"PHONENUMBER" : {
+
      "default": "null",
"$id" : "#/properties/PHONENUMBER",
+
      "examples": [
"type" : "string",
+
        {
"title" : "The PHONENUMBER Schema",
+
          "EstablishedDate": "2010-04-30T12:03:30.133Z"
"default" : "",
+
        },
"examples" : [ ]
+
        {
},
+
          "definition": "Date and time in ISO 8601 standard"
"TCONNECTIONID" : {
+
        }
"$id" : "#/properties/TCONNECTIONID",
+
      ]
"type" : "string",
+
    },
"title" : "The TCONNECTIONID Schema",
+
    "RELEASEDDATE": {
"default" : "",
+
      "$id": "#/properties/RELEASEDDATE",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The RELEASEDDATE Schema",
"CALLBACKSTATUS" : {
+
      "default": "null",
"$id" : "#/properties/CALLBACKSTATUS",
+
      "examples": [
"type" : "integer",
+
        {
"title" : "The CALLBACKSTATUS Schema",
+
          "definition": "Date and time in ISO 8601 standard"
"default" : "",
+
        },
"examples" : [ ]
+
        {
},
+
          "ReleasedDate": "2010-04-30T12:03:30.133Z"
"DETAILEDDESCRIPTION" : {
+
        }
"$id" : "#/properties/DETAILEDDESCRIPTION",
+
      ]
"type" : "string",
+
    },
"title" : "The DETAILEDDESCRIPTION Schema",
+
    "DURATION": {
"default" : "",
+
      "$id": "#/properties/DURATION",
"examples" : [ ]
+
      "type": "integer",
},
+
      "title": "The DURATION Schema",
"CUSTOMDATA" : {
+
      "default": "",
"$id" : "#/properties/CUSTOMDATA",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The CUSTOMDATA Schema",
+
    "OUTCOME": {
"default" : "",
+
      "$id": "#/properties/OUTCOME",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The OUTCOME Schema",
"DESIREDRESPONSETYPE" : {
+
      "default": "",
"$id" : "#/properties/DESIREDRESPONSETYPE",
+
      "examples": []
"type" : "integer",
+
    },
"title" : "The DESIREDRESPONSETYPE Schema",
+
    "PHONENUMBER": {
"default" : "",
+
      "$id": "#/properties/PHONENUMBER",
"examples" : [ ]
+
      "type": "string",
},
+
      "title": "The PHONENUMBER Schema",
"STARTTIME" : {
+
      "default": "",
"$id" : "#/properties/STARTTIME",
+
      "examples": []
"type" : "string",
+
    },
"title" : "The STARTTIME Schema",
+
    "TCONNECTIONID": {
"default" : "null",
+
      "$id": "#/properties/TCONNECTIONID",
"examples" : [ {
+
      "type": "string",
"StartTime" : "2010-04-30T12:03:30.133Z"
+
      "title": "The TCONNECTIONID Schema",
}, {
+
      "default": "",
"definition" : "Date and time in ISO 8601 standard"
+
      "examples": []
} ]
+
    },
},
+
    "CALLBACKSTATUS": {
"ENDTIME" : {
+
      "$id": "#/properties/CALLBACKSTATUS",
"$id" : "#/properties/ENDTIME",
+
      "type": "integer",
"type" : "string",
+
      "title": "The CALLBACKSTATUS Schema",
"title" : "The ENDTIME Schema",
+
      "default": "",
"default" : "null",
+
      "examples": []
"examples" : [ {
+
    },
"EndTime" : "2010-04-30T12:03:30.133Z"
+
    "DETAILEDDESCRIPTION": {
}, {
+
      "$id": "#/properties/DETAILEDDESCRIPTION",
"definition" : "Date and time in ISO 8601 standard"
+
      "type": "string",
} ]
+
      "title": "The DETAILEDDESCRIPTION Schema",
},
+
      "default": "",
"CUSTOMERNUMBER" : {
+
      "examples": []
"$id" : "#/properties/CUSTOMERNUMBER",
+
    },
"type" : "string",
+
    "CUSTOMDATA": {
"title" : "The CUSTOMERNUMBER Schema",
+
      "$id": "#/properties/CUSTOMDATA",
"default" : "",
+
      "type": "string",
"examples" : [ ]
+
      "title": "The CUSTOMDATA Schema",
},
+
      "default": "",
"ATTEMPTS" : {
+
      "examples": []
"$id" : "#/properties/ATTEMPTS",
+
    },
"type" : "integer",
+
    "DESIREDRESPONSETYPE": {
"title" : "The ATTEMPTS Schema",
+
      "$id": "#/properties/DESIREDRESPONSETYPE",
"default" : "",
+
      "type": "integer",
"examples" : [ ]
+
      "title": "The DESIREDRESPONSETYPE Schema",
},
+
      "default": "",
"DN" : {
+
      "examples": []
"$id" : "#/properties/DN",
+
    },
"type" : "string",
+
    "STARTTIME": {
"title" : "The DN Schema",
+
      "$id": "#/properties/STARTTIME",
"default" : "",
+
      "type": "string",
"examples" : [ ]
+
      "title": "The STARTTIME Schema",
},
+
      "default": "null",
"LOCATION" : {
+
      "examples": [
"$id" : "#/properties/LOCATION",
+
        {
"type" : "string",
+
          "StartTime": "2010-04-30T12:03:30.133Z"
"title" : "The LOCATION Schema",
+
        },
"default" : "",
+
        {
"examples" : [ ]
+
          "definition": "Date and time in ISO 8601 standard"
},
+
        }
"CALLBACKSERVERID" : {
+
      ]
"$id" : "#/properties/CALLBACKSERVERID",
+
    },
"type" : "string",
+
    "ENDTIME": {
"title" : "The CALLBACKSERVERID Schema",
+
      "$id": "#/properties/ENDTIME",
"default" : "",
+
      "type": "string",
"examples" : [ ]
+
      "title": "The ENDTIME Schema",
},
+
      "default": "null",
"CALLRESULT" : {
+
      "examples": [
"$id" : "#/properties/CALLRESULT",
+
        {
"type" : "integer",
+
          "EndTime": "2010-04-30T12:03:30.133Z"
"title" : "The CALLRESULT Schema",
+
        },
"default" : "",
+
        {
"examples" : [ ]
+
          "definition": "Date and time in ISO 8601 standard"
},
+
        }
"THETYPE" : {
+
      ]
"$id" : "#/properties/THETYPE",
+
    },
"type" : "integer",
+
    "CUSTOMERNUMBER": {
"title" : "The THETYPE Schema",
+
      "$id": "#/properties/CUSTOMERNUMBER",
"default" : "",
+
      "type": "string",
"examples" : [ ]
+
      "title": "The CUSTOMERNUMBER Schema",
},
+
      "default": "",
"MIMETYPE" : {
+
      "examples": []
"$id" : "#/properties/MIMETYPE",
+
    },
"type" : "string",
+
    "ATTEMPTS": {
"title" : "The MIMETYPE Schema",
+
      "$id": "#/properties/ATTEMPTS",
"default" : "",
+
      "type": "integer",
"examples" : [ ]
+
      "title": "The ATTEMPTS Schema",
},
+
      "default": "",
"THESIZE" : {
+
      "examples": []
"$id" : "#/properties/THESIZE",
+
    },
"type" : "integer",
+
    "DN": {
"title" : "The THESIZE Schema",
+
      "$id": "#/properties/DN",
"default" : "",
+
      "type": "string",
"examples" : [ ]
+
      "title": "The DN Schema",
},
+
      "default": "",
"CONTENT" : {
+
      "examples": []
"$id" : "#/properties/CONTENT",
+
    },
"type" : "string",
+
    "LOCATION": {
"title" : "The CONTENT Schema",
+
      "$id": "#/properties/LOCATION",
"default" : "null",
+
      "type": "string",
"examples" : [ {
+
      "title": "The LOCATION Schema",
"definition" : "Encoded mail content in Binary64 format"
+
      "default": "",
} ]
+
      "examples": []
},
+
    },
"SUBSCRIBERID" : {
+
    "CALLBACKSERVERID": {
"$id" : "#/properties/SUBSCRIBERID",
+
      "$id": "#/properties/CALLBACKSERVERID",
"type" : "string",
+
      "type": "string",
"title" : "The SUBSCRIBERID Schema",
+
      "title": "The CALLBACKSERVERID Schema",
"default" : "null",
+
      "default": "",
"examples" : [ {
+
      "examples": []
"definition" : "Name of the business line, when defined"
+
    },
} ]
+
    "CALLRESULT": {
}
+
      "$id": "#/properties/CALLRESULT",
}
+
      "type": "integer",
 +
      "title": "The CALLRESULT Schema",
 +
      "default": "",
 +
      "examples": []
 +
    },
 +
    "THETYPE": {
 +
      "$id": "#/properties/THETYPE",
 +
      "type": "integer",
 +
      "title": "The THETYPE Schema",
 +
      "default": "",
 +
      "examples": []
 +
    },
 +
    "MIMETYPE": {
 +
      "$id": "#/properties/MIMETYPE",
 +
      "type": "string",
 +
      "title": "The MIMETYPE Schema",
 +
      "default": "",
 +
      "examples": []
 +
    },
 +
    "THESIZE": {
 +
      "$id": "#/properties/THESIZE",
 +
      "type": "integer",
 +
      "title": "The THESIZE Schema",
 +
      "default": "",
 +
      "examples": []
 +
    },
 +
    "CONTENT": {
 +
      "$id": "#/properties/CONTENT",
 +
      "type": "string",
 +
      "title": "The CONTENT Schema",
 +
      "default": "null",
 +
      "examples": [
 +
        {
 +
          "definition": "Encoded mail content in Binary64 format"
 +
        }
 +
      ]
 +
    },
 +
    "SUBSCRIBERID": {
 +
      "$id": "#/properties/SUBSCRIBERID",
 +
      "type": "string",
 +
      "title": "The SUBSCRIBERID Schema",
 +
      "default": "null",
 +
      "examples": [
 +
        {
 +
          "definition": "Name of the business line, when defined"
 +
        }
 +
      ]
 +
    }
 +
  }
 
}
 
}
 
</source>
 
</source>
Line 763: Line 811:
  
 
<source lang="text">
 
<source lang="text">
{"STARTDATE" : "2012-03-30T10:29:50.407Z",  
+
{
"MIMETYPE" : "message\/rfc822",  
+
  "STARTDATE": "2012-03-30T10:29:50.407Z",
"HEADER" : "UmV0dXJuLVBhdGg6IENs==",  
+
  "MIMETYPE": "message/rfc822",
"ENTITYTYPEID" : 0,  
+
  "HEADER": "UmV0dXJuLVBhdGg6IENsaWVudDFAY3VzdC5kZXYNClJlY2VpdmVkOiBmcm9tIGJzZ2VueHA0Y2lpdyAoWzE3Mi4yNS4xNTcuNzddKQ0KCWJ5IGxvY2FsaG9zdA0KCTsgRnJpLCAzMCBNYXIgMjAxMiAxMjoyOTozNiArMDIwMA0KTWVzc2FnZS1JRDogPDE1NjU1Nzg4LjEzMzMxMDMyOTQ1NTAuSmF2YU1haWwuZ2VuZXN5c0Bic2dlbjgxMGNpaXc+DQpEYXRlOiBGcmksIDMwIE1hciAyMDEyIDEyOjI4OjE0ICswMjAwIChDRVNUKQ0KRnJvbTogQ2xpZW50MUBjdXN0LmRldg0KVG86IG1haW5AbWNyLmRldg0KU3ViamVjdDogQXV0b21hdGljIHRlc3RzIHZpYSBTaWt1bGkgLSBDaGVjayBtZW1vcnkgbGVhaw0KTWltZS1WZXJzaW9uOiAxLjANCkNvbnRlbnQtVHlwZTogbXVsdGlwYXJ0L21peGVkOyBib3VuZGFyeT0iLS0tLT1fUGFydF8wXzgwMjYzMjMuMTMzMzEwMzI5NDUzNSINCg==",
"CONTENT" : "UmV0dXJuLVBhdGg6IENs==",  
+
  "ENTITYTYPEID": 0,
"SUBTYPEID" : "InboundNew",  
+
  "CONTENT": "UmV0dXJuLVBhdGg6IENsaWVudDFAY3VzdC5kZXYNClJlY2VpdmVkOiBmcm9tIGJzZ2VueHA0Y2lpdyAoWzE3Mi4yNS4xNTcuNzddKQ0KCWJ5IGxvY2FsaG9zdA0KCTsgRnJpLCAzMCBNYXIgMjAxMiAxMjoyOTozNiArMDIwMA0KTWVzc2FnZS1JRDogPDE1NjU1Nzg4LjEzMzMxMDMyOTQ1NTAuSmF2YU1haWwuZ2VuZXN5c0Bic2dlbjgxMGNpaXc+DQpEYXRlOiBGcmksIDMwIE1hciAyMDEyIDEyOjI4OjE0ICswMjAwIChDRVNUKQ0KRnJvbTogQ2xpZW50MUBjdXN0LmRldg0KVG86IG1haW5AbWNyLmRldg0KU3ViamVjdDogQXV0b21hdGljIHRlc3RzIHZpYSBTaWt1bGkgLSBDaGVjayBtZW1vcnkgbGVhaw0KTWltZS1WZXJzaW9uOiAxLjANCkNvbnRlbnQtVHlwZTogbXVsdGlwYXJ0L21peGVkOyBib3VuZGFyeT0iLS0tLT1fUGFydF8wXzgwMjYzMjMuMTMzMzEwMzI5NDUzNSINCg0KLS0tLS0tPV9QYXJ0XzBfODAyNjMyMy4xMzMzMTAzMjk0NTM1DQpDb250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9dXMtYXNjaWkNCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQNCg0KIDAgVGVzdCBtZW1vcnkgbGVhayANCi0tLS0tLT1fUGFydF8wXzgwMjYzMjMuMTMzMzEwMzI5NDUzNS0tDQoNCg==",
"CONTACTID" : "0000Xa6VJTWV000M",  
+
  "SUBTYPEID": "InboundNew",
"OWNERID" : 126,  
+
  "CONTACTID": "0000Xa6VJTWV000M",
"MAILBOX" : "\"Contact Center\" <main@mcr.dev>",  
+
  "OWNERID": 126,
"CREATORAPPID" : 171,  
+
  "MAILBOX": "\"Contact Center\" <main@mcr.dev>",
"MEDIATYPEID" : "email",  
+
  "CREATORAPPID": 171,
"STATUS" : 3,  
+
  "MEDIATYPEID": "email",
"TENANTID" : 101,  
+
  "STATUS": 3,
"IXNID" : "0002Ha7QB2MX000R",  
+
  "TENANTID": 101,
"FROMADDRESS" : "Client1@cust.dev",  
+
  "IXNID": "0002Ha7QB2MX000R",
"CANBEPARENT" : 1,  
+
  "FROMADDRESS": "Client1@cust.dev",
"TEXT" : " 0 Test memory leak ",  
+
  "CANBEPARENT": 1,
"TOADDRESSES" : "main@mcr.dev",  
+
  "TEXT": " 0 Test memory leak ",
"ENDDATE" : "2012-03-30T10:29:32.957Z",  
+
  "TOADDRESSES": "main@mcr.dev",
"THREADHASH" : 20772491,  
+
  "ENDDATE": "2012-03-30T10:29:32.957Z",
"EXTERNALID" : "<15655788.133310xxxx550.JavaMail.genesys@bsgen810ciiw>",  
+
  "THREADHASH": 20772491,
"ALLATTRIBUTES" : {"CBR-actual_volume" : "",  
+
  "EXTERNALID": "<15655788.1333103294550.JavaMail.genesys@bsgen810ciiw>",
"Ctg_0000Ra6J43AQ00AQ" : "60",  
+
  "ALLATTRIBUTES": {
"RStrategyDBID" : "252",  
+
    "CBR-actual_volume": "",
"RVQDBID" : "",  
+
    "Ctg_0000Ra6J43AQ00AQ": "60",
"_ackDone" : "1",  
+
    "RStrategyDBID": "252",
"ServiceObjective" : 0,  
+
    "RVQDBID": "",
"_ContainsAttachment" : "false",  
+
    "_ackDone": "1",
"RTargetAgentSelected" : "1004",  
+
    "ServiceObjective": 0,
"Ctg_0002Fa13WJWS0AU0" : "50",  
+
    "_ContainsAttachment": "false",
"RVQID" : "",  
+
    "RTargetAgentSelected": "1004",
"CustomerSegment" : "default",  
+
    "Ctg_0002Fa13WJWS0AU0": "50",
"CBR-IT-path_DBIDs" : "",  
+
    "RVQID": "",
"_AutoReplyCount" : 0,  
+
    "CustomerSegment": "default",
"Subject" : "Automatic tests via Sikuli - Check memory leak",  
+
    "CBR-IT-path_DBIDs": "",
"Mailbox" : "\"Contact Center\" <main@mcr.dev>",  
+
    "_AutoReplyCount": 0,
"CtgId" : "0002Fa13WJWS0AUH",  
+
    "Subject": "Automatic tests via Sikuli - Check memory leak",
"FirstName" : "Client1",  
+
    "Mailbox": "\"Contact Center\" <main@mcr.dev>",
"ContactId" : "0000Xa6VJTWV000M",  
+
    "CtgId": "0002Fa13WJWS0AUH",
"CBR-Interaction_cost" : "",  
+
    "FirstName": "Client1",
"FromPersonal" : "",  
+
    "ContactId": "0000Xa6VJTWV000M",
"RStrategyName" : "email-routing-inbound",  
+
    "CBR-Interaction_cost": "",
"RTargetRequested" : "Agent Group 80001",  
+
    "FromPersonal": "",
"RTargetObjSelDBID" : "116",  
+
    "RStrategyName": "email-routing-inbound",
"RTargetAgentGroup" : "Agent Group 80001"...
+
    "RTargetRequested": "Agent Group 80001",
 +
    "RTargetObjSelDBID": "116",
 +
    "RTargetAgentGroup": "Agent Group 80001",
 +
    "IW_CaseUid": "bd04cb63-3eb8-42b1-8dc8-893271de62bf",
 +
    "IW_BundleUid": "497f696f-159a-4682-a8cd-30f78bc1b147",
 +
    "RRequestedSkillCombination": "",
 +
    "RTargetRuleSelected": "",
 +
    "RTargetObjectSelected": "Agent Group 80001",
 +
    "Header_Content-Type": "multipart/mixed; boundary=\"----=_Part_0_8026323.1333103294535\"",
 +
    "RTargetTypeSelected": "2",
 +
    "FromAddress": "Client1@cust.dev",
 +
    "Header_Date": "Fri, 30 Mar 2012 12:28:14 +0200 (CEST)",
 +
    "Header_Mime-Version": "1.0",
 +
    "Header_Message-ID": "<15655788.1333103294550.JavaMail.genesys@bsgen810ciiw>",
 +
    "RTenant": "defaultTenant",
 +
    "ServiceType": "default",
 +
    "To": "main@mcr.dev",
 +
    "Origination_Source": "Email",
 +
    "_AttachmentsSize": "0",
 +
    "IWAttachedDataInformation": {
 +
      "DispositionCodeValues.DC_Accepted": "Accepted",
 +
      "CaseDataOrder": "",
 +
      "CaseData.URL1": "URL1",
 +
      "CaseData.Segment": "Segment",
 +
      "CaseData.CallType": "Call Type",
 +
      "DispositionCode.Key": "DispositionCode",
 +
      "DispositionCodeValues.DC_Transferred": "Transferred",
 +
      "Option.interaction.case-data.header-foreground-color": "#FF15428B",
 +
      "Option.expression.url": "(?#Protocol)(?:(?:ht|f)tp(?:s?)\\:\\/\\/|~/|/)?(?#Username:Password)(?:\\w+:\\w+@)?(?#Subdomains)(?:(?:[-\\w]+\\.)+(?#TopLevel Domains)(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|museum|travel|[a-z]{2}))(?#Port)(?::[\\d]{1,5})?(?#Directories)(?:(?:(?:/(?:[-\\w~!$+|.,=]|%[a-f\\d]{2})+)+|/)+|\\?|#)?(?#Query)(?:(?:\\?(?:[-\\w~!$+|.,*:]|%[a-f\\d{2}])+=(?:[-\\w~!$+|.,*:=]|%[a-f\\d]{2})*)(?:&(?:[-\\w~!$+|.,*:]|%[a-f\\d{2}])+=(?:[-\\w~!$+|.,*:=]|%[a-f\\d]{2})*)*)*(?#Anchor)(?:#(?:[-\\w~!$+|.,*:=]|%[a-f\\d]{2})*)?",
 +
      "CaseData.URL2": "URL2",
 +
      "Option.interaction.case-data.frame-color": "#FFFFBA00",
 +
      "DispositionCode.Label": "Disposition Code",
 +
      "DispositionCodeValues.DC_Rejected": "Rejected",
 +
      "CaseData.Priority": "Priority",
 +
      "CaseData.Reason": "Reason"
 +
    },
 +
    "PegAGAgent Group 80001": 1,
 +
    "RRequestedSkills": {},
 +
    "RTargetPlaceSelected": "Place_1004",
 +
    "Ctg_0000Ra6J43AQ00A4": "12",
 +
    "CBR-contract_DBIDs": "",
 +
    "CtgRelevancy": "84",
 +
    "EmailAddress": "Client1@cust.dev"
 +
  },
 +
  "TIMESHIFT": 120,
 +
  "SENTDATE": "2012-03-30T10:28:14.000Z",
 +
  "THESIZE": 622,
 +
  "SUBJECT": "Automatic tests via Sikuli - Check memory leak",
 +
  "THREADID": "0002Ha7QB2MX000S",
 +
  "TYPEID": "Inbound"
 +
}
 
</source>
 
</source>
 
</toggledisplay>
 
</toggledisplay>
 
{{AnchorDiv|docschema}}
 
{{AnchorDiv|docschema}}
 +
 
=== Document schema ===
 
=== Document schema ===
  
Line 818: Line 917:
 
<source lang="text">
 
<source lang="text">
 
{
 
{
"definitions" : { },
+
  "definitions": {},
"$schema" : "http://json-schema.org/draft-07/schema#",
+
  "$schema": "http://json-schema.org/draft-07/schema#",
"$id" : "http://genesys.com/gdps/schema/9.0.001.07/document.json",
+
  "$id": "http://genesys.com/gdps/schema/9.0.001.07/document.json",
"type" : "object",
+
  "type": "object",
"title" : "Document schema",
+
  "title": "Document schema",
"required" : [ ],
+
  "required": [],
"properties" : {
+
  "properties": {
"ID" : {
+
    "ID": {
"$id" : "#/properties/ID",
+
      "$id": "#/properties/ID",
"type" : "string",
+
      "type": "string",
"title" : "The ID Schema",
+
      "title": "The ID Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"MIMETYPE" : {
+
    "MIMETYPE": {
"$id" : "#/properties/MIMETYPE",
+
      "$id": "#/properties/MIMETYPE",
"type" : "string",
+
      "type": "string",
"title" : "The MIMETYPE Schema",
+
      "title": "The MIMETYPE Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"THENAME" : {
+
    "THENAME": {
"$id" : "#/properties/THENAME",
+
      "$id": "#/properties/THENAME",
"type" : "string",
+
      "type": "string",
"title" : "The THENAME Schema",
+
      "title": "The THENAME Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"DESCRIPTION" : {
+
    "DESCRIPTION": {
"$id" : "#/properties/DESCRIPTION",
+
      "$id": "#/properties/DESCRIPTION",
"type" : "string",
+
      "type": "string",
"title" : "The DESCRIPTION Schema",
+
      "title": "The DESCRIPTION Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"THESIZE" : {
+
    "THESIZE": {
"$id" : "#/properties/THESIZE",
+
      "$id": "#/properties/THESIZE",
"type" : "integer",
+
      "type": "integer",
"title" : "The THESIZE Schema",
+
      "title": "The THESIZE Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"CONTENT" : {
+
    "CONTENT": {
"$id" : "#/properties/CONTENT",
+
      "$id": "#/properties/CONTENT",
"type" : "string",
+
      "type": "string",
"title" : "The CONTENT Schema",
+
      "title": "The CONTENT Schema",
"default" : "null",
+
      "default": "null",
"examples" : [ {
+
      "examples": [
"definition" : "Encoded mail content in Binary64 format"
+
        {
} ]
+
          "definition": "Encoded mail content in Binary64 format"
},
+
        }
"DOCUMENTID" : {
+
      ]
"$id" : "#/properties/DOCUMENTID",
+
    },
"type" : "string",
+
    "DOCUMENTID": {
"title" : "The DOCUMENTID Schema",
+
      "$id": "#/properties/DOCUMENTID",
"default" : "",
+
      "type": "string",
"examples" : [ ]
+
      "title": "The DOCUMENTID Schema",
},
+
      "default": "",
"ENTITYID" : {
+
      "examples": []
"$id" : "#/properties/ENTITYID",
+
    },
"type" : "string",
+
    "ENTITYID": {
"title" : "The ENTITYID Schema",
+
      "$id": "#/properties/ENTITYID",
"default" : "",
+
      "type": "string",
"examples" : [ ]
+
      "title": "The ENTITYID Schema",
},
+
      "default": "",
"ENTITYTYPEID" : {
+
      "examples": []
"$id" : "#/properties/ENTITYTYPEID",
+
    },
"type" : "integer",
+
    "ENTITYTYPEID": {
"title" : "The ENTITYTYPEID Schema",
+
      "$id": "#/properties/ENTITYTYPEID",
"default" : "null",
+
      "type": "integer",
"examples" : [ {
+
      "title": "The ENTITYTYPEID Schema",
"values" : "0: EmailIn, 1: EmailOut, 2: Chat, 3: PhoneCall, 5: Callback, 6: CoBrowse, 7: Interaction"
+
      "default": "null",
}, {
+
      "examples": [
"definition" : "Interaction type available through a set of enums"
+
        {
} ]
+
          "values": "0: EmailIn, 1: EmailOut, 2: Chat, 3: PhoneCall, 5: Callback, 6: CoBrowse, 7: Interaction"
}
+
        },
}
+
        {
 +
          "definition": "Interaction type available through a set of enums"
 +
        }
 +
      ]
 +
    }
 +
  }
 
}
 
}
 
</source>
 
</source>
Line 904: Line 1,008:
  
 
<source lang="text">
 
<source lang="text">
{"ID" : "0003Ra7VSTDP03H0",  
+
{
"MIMETYPE" : "message\/rfc822",  
+
  "ID": "0003Ra7VSTDP03H0",
"DESCRIPTION" : "", "ENTITYTYPEID" : 0,  
+
  "MIMETYPE": "message/rfc822",
"CONTENT" : "UmV0dXJuLVBhdGg6IENsaWVudD==",  
+
  "DESCRIPTION": "",
"THENAME" : "OriginalMsg.eml",  
+
  "ENTITYTYPEID": 0,
"DOCUMENTID" : "0003Ra7VSTDP03H0",  
+
  "CONTENT": "UmV0dXJuLVBhdGg6IENsaWVudDFAY3VzdC5kZXYNClJlY2VpdmVkOiBmcm9tIGJzZ2VueHA0Y2lpdyAoWzE3Mi4yNS4xNTcuNzddKQ0KCWJ5IGxvY2FsaG9zdA0KCTsgVHVlLCA1IEp1biAyMDEyIDEwOjU3OjAzICswMjAwDQpNZXNzYWdlLUlEOiA8MjI3NzIxMDIuMTMzODg4NjYyMzQ2NS5KYXZhTWFpbC5nZW5lc3lzQGJzZ2VuODEwY2lpdz4NCkRhdGU6IFR1ZSwgNSBKdW4gMjAxMiAxMDo1NzowMyArMDIwMCAoQ0VTVCkNCkZyb206IENsaWVudDFAY3VzdC5kZXYNClRvOiBtYWluQG1jci5kZXYNClN1YmplY3Q6IEF1dG9tYXRpYyB0ZXN0cyB2aWEgU2lrdWxpIC0gQ2hlY2sgbWVtb3J5IGxlYWsNCk1pbWUtVmVyc2lvbjogMS4wDQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9taXhlZDsgDQoJYm91bmRhcnk9Ii0tLS09X1BhcnRfMzZfMjUzMDA0NDIuMTMzODg4NjYyMzQ2NSINCg0KLS0tLS0tPV9QYXJ0XzM3Xzg4ODA0OTMuMTMzODg4NjYyMzQ2NQ0KQ29udGVudC1UeXBlOiB0ZXh0L3BsYWluOyBjaGFyc2V0PXVzLWFzY2lpDQpDb250ZW50LVRyYW5zZmVyLUVuY29kaW5nOiA3Yml0DQoNCiAzNyBUZXN0IG1lbW9yeSBsZWFrIA0KLS0tLS0tPV9QYXJ0XzM3Xzg4ODA0OTMuMTMzODg4NjYyMzQ2NS0tDQoNCg==",
"ENTITYID" : "0003Ra7VSTDP03FU",  
+
  "THENAME": "OriginalMsg.eml",
"THESIZE" : 628}
+
  "DOCUMENTID": "0003Ra7VSTDP03H0",
 +
  "ENTITYID": "0003Ra7VSTDP03FU",
 +
  "THESIZE": 628
 +
}
 
</source>
 
</source>
  
Line 926: Line 1,033:
  
 
<source lang="text">
 
<source lang="text">
"ALLATTRIBUTES" : {"CBR-actual_volume" : "",  
+
"ALLATTRIBUTES" : {
"Ctg_0000Ra6J43AQ00AQ" : "60",  
+
  "CBR-actual_volume": "",
"RStrategyDBID" : "252",  
+
  "Ctg_0000Ra6J43AQ00AQ": "60",
"RVQDBID" : "",  
+
  "RStrategyDBID": "252",
"_ackDone" : "1",  
+
  "RVQDBID": "",
"ServiceObjective" : 0,  
+
  "_ackDone": "1",
"_ContainsAttachment" : "false",  
+
  "ServiceObjective": 0,
"RTargetAgentSelected" : "1004",  
+
  "_ContainsAttachment": "false",
"Ctg_0002Fa13WJWS0AU0" : "50",  
+
  "RTargetAgentSelected": "1004",
"RVQID" : "",  
+
  "Ctg_0002Fa13WJWS0AU0": "50",
"CustomerSegment" : "default",  
+
  "RVQID": "",
"CBR-IT-path_DBIDs" : "",  
+
  "CustomerSegment": "default",
"_AutoReplyCount" : 0,  
+
  "CBR-IT-path_DBIDs": "",
"Subject" : "Automatic tests via Sikuli - Check memory leak",  
+
  "_AutoReplyCount": 0,
"Mailbox" : "\"Contact Center\" <main@mcr.dev>",  
+
  "Subject": "Automatic tests via Sikuli - Check memory leak",
"EmailAddress" : "Client1@cust.dev"}
+
  "Mailbox": "\"Contact Center\" <main@mcr.dev>",
 +
  "CtgId": "0002Fa13WJWS0AUH",
 +
  "FirstName": "Client1",
 +
  "ContactId": "0000Xa6VJTWV000M",
 +
  "CBR-Interaction_cost": "",
 +
  "FromPersonal": "",
 +
  "RStrategyName": "email-routing-inbound",
 +
  "RTargetRequested": "Agent Group 80001",
 +
  "RTargetObjSelDBID": "116",
 +
  "RTargetAgentGroup": "Agent Group 80001",
 +
  "IW_CaseUid": "bd04cb63-3eb8-42b1-8dc8-893271de62bf",
 +
  "IW_BundleUid": "497f696f-159a-4682-a8cd-30f78bc1b147",
 +
  "RRequestedSkillCombination": "",
 +
  "RTargetRuleSelected": "",
 +
  "RTargetObjectSelected": "Agent Group 80001",
 +
  "Header_Content-Type": "multipart/mixed; boundary=\"----=_Part_0_8026323.1333103294535\"",
 +
  "RTargetTypeSelected": "2",
 +
  "FromAddress": "Client1@cust.dev",
 +
  "Header_Date": "Fri, 30 Mar 2012 12:28:14 +0200 (CEST)",
 +
  "Header_Mime-Version": "1.0",
 +
  "Header_Message-ID": "<15655788.1333103294550.JavaMail.genesys@bsgen810ciiw>",
 +
  "RTenant": "defaultTenant",
 +
  "ServiceType": "default",
 +
  "To": "main@mcr.dev",
 +
  "Origination_Source": "Email",
 +
  "_AttachmentsSize": "0",
 +
  "IWAttachedDataInformation": {
 +
    "DispositionCodeValues.DC_Accepted": "Accepted",
 +
    "CaseDataOrder": "",
 +
    "CaseData.URL1": "URL1",
 +
    "CaseData.Segment": "Segment",
 +
    "CaseData.CallType": "Call Type",
 +
    "DispositionCode.Key": "DispositionCode",
 +
    "DispositionCodeValues.DC_Transferred": "Transferred",
 +
    "Option.interaction.case-data.header-foreground-color": "#FF15428B",
 +
    "Option.expression.url": "(?#Protocol)(?:(?:ht|f)tp(?:s?)\\:\\/\\/|~/|/)?(?#Username:Password)(?:\\w+:\\w+@)?(?#Subdomains)(?:(?:[-\\w]+\\.)+(?#TopLevel Domains)(?:com|org|net|gov|mil|biz|info|mobi|name|aero|jobs|museum|travel|[a-z]{2}))(?#Port)(?::[\\d]{1,5})?(?#Directories)(?:(?:(?:/(?:[-\\w~!$+|.,=]|%[a-f\\d]{2})+)+|/)+|\\?|#)?(?#Query)(?:(?:\\?(?:[-\\w~!$+|.,*:]|%[a-f\\d{2}])+=(?:[-\\w~!$+|.,*:=]|%[a-f\\d]{2})*)(?:&(?:[-\\w~!$+|.,*:]|%[a-f\\d{2}])+=(?:[-\\w~!$+|.,*:=]|%[a-f\\d]{2})*)*)*(?#Anchor)(?:#(?:[-\\w~!$+|.,*:=]|%[a-f\\d]{2})*)?",
 +
    "CaseData.URL2": "URL2",
 +
    "Option.interaction.case-data.frame-color": "#FFFFBA00",
 +
    "DispositionCode.Label": "Disposition Code",
 +
    "DispositionCodeValues.DC_Rejected": "Rejected",
 +
    "CaseData.Priority": "Priority",
 +
    "CaseData.Reason": "Reason"
 +
  },
 +
  "PegAGAgent Group 80001": 1,
 +
  "RRequestedSkills": {},
 +
  "RTargetPlaceSelected": "Place_1004",
 +
  "Ctg_0000Ra6J43AQ00A4": "12",
 +
  "CBR-contract_DBIDs": "",
 +
  "CtgRelevancy": "84",
 +
  "EmailAddress": "Client1@cust.dev"
 +
}
 
</source>
 
</source>
  
Line 958: Line 1,115:
 
<source lang="text">
 
<source lang="text">
 
{
 
{
"definitions" : { },
+
  "definitions": {},
"$schema" : "http://json-schema.org/draft-07/schema#",
+
  "$schema": "http://json-schema.org/draft-07/schema#",
"$id" : "http://genesys.com/gdps/schema/9.0.001.07/contact.json",
+
  "$id": "http://genesys.com/gdps/schema/9.0.001.07/contact.json",
"type" : "object",
+
  "type": "object",
"title" : "Contact schema",
+
  "title": "Contact schema",
"required" : [ "CONTACTID" ],
+
  "required": [
"properties" : {
+
    "CONTACTID"
"CONTACTID" : {
+
  ],
"$id" : "#/properties/CONTACTID",
+
  "properties": {
"type" : "string",
+
    "CONTACTID": {
"title" : "The CONTACTID Schema",
+
      "$id": "#/properties/CONTACTID",
"default" : "16 characters",
+
      "type": "string",
"examples" : [ {
+
      "title": "The CONTACTID Schema",
"example of contactId" : "18PKMJG3K82TRGG1"
+
      "default": "16 characters",
}, {
+
      "examples": [
"Length" : "16 characters"
+
        {
} ]
+
          "example of contactId": "18PKMJG3K82TRGG1"
},
+
        },
"TENANTID" : {
+
        {
"$id" : "#/properties/TENANTID",
+
          "Length": "16 characters"
"type" : "integer",
+
        }
"title" : "The TENANTID Schema",
+
      ]
"default" : "",
+
    },
"examples" : [ ]
+
    "TENANTID": {
},
+
      "$id": "#/properties/TENANTID",
"SUBTENANTID" : {
+
      "type": "integer",
"$id" : "#/properties/SUBTENANTID",
+
      "title": "The TENANTID Schema",
"type" : "integer",
+
      "default": "",
"title" : "The SUBTENANTID Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "SUBTENANTID": {
},
+
      "$id": "#/properties/SUBTENANTID",
"ISEXTERNALRESOURCE" : {
+
      "type": "integer",
"$id" : "#/properties/ISEXTERNALRESOURCE",
+
      "title": "The SUBTENANTID Schema",
"type" : "integer",
+
      "default": "",
"title" : "The ISEXTERNALRESOURCE Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "ISEXTERNALRESOURCE": {
},
+
      "$id": "#/properties/ISEXTERNALRESOURCE",
"STRATTRIBUTE1" : {
+
      "type": "integer",
"$id" : "#/properties/STRATTRIBUTE1",
+
      "title": "The ISEXTERNALRESOURCE Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE1 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE1": {
},
+
      "$id": "#/properties/STRATTRIBUTE1",
"STRATTRIBUTE2" : {
+
      "type": "string",
"$id" : "#/properties/STRATTRIBUTE2",
+
      "title": "The STRATTRIBUTE1 Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE2 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE2": {
},
+
      "$id": "#/properties/STRATTRIBUTE2",
"STRATTRIBUTE3" : {
+
      "type": "string",
"$id" : "#/properties/STRATTRIBUTE3",
+
      "title": "The STRATTRIBUTE2 Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE3 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE3": {
},
+
      "$id": "#/properties/STRATTRIBUTE3",
"STRATTRIBUTE4" : {
+
      "type": "string",
"$id" : "#/properties/STRATTRIBUTE4",
+
      "title": "The STRATTRIBUTE3 Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE4 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE4": {
},
+
      "$id": "#/properties/STRATTRIBUTE4",
"STRATTRIBUTE5" : {
+
      "type": "string",
"$id" : "#/properties/STRATTRIBUTE5",
+
      "title": "The STRATTRIBUTE4 Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE5 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE5": {
},
+
      "$id": "#/properties/STRATTRIBUTE5",
"STRATTRIBUTE6" : {
+
      "type": "string",
"$id" : "#/properties/STRATTRIBUTE6",
+
      "title": "The STRATTRIBUTE5 Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE6 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE6": {
},
+
      "$id": "#/properties/STRATTRIBUTE6",
"STRATTRIBUTE7" : {
+
      "type": "string",
"$id" : "#/properties/STRATTRIBUTE7",
+
      "title": "The STRATTRIBUTE6 Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE7 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE7": {
},
+
      "$id": "#/properties/STRATTRIBUTE7",
"STRATTRIBUTE8" : {
+
      "type": "string",
"$id" : "#/properties/STRATTRIBUTE8",
+
      "title": "The STRATTRIBUTE7 Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE8 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE8": {
},
+
      "$id": "#/properties/STRATTRIBUTE8",
"STRATTRIBUTE9" : {
+
      "type": "string",
"$id" : "#/properties/STRATTRIBUTE9",
+
      "title": "The STRATTRIBUTE8 Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE9 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE9": {
},
+
      "$id": "#/properties/STRATTRIBUTE9",
"STRATTRIBUTE10" : {
+
      "type": "string",
"$id" : "#/properties/STRATTRIBUTE10",
+
      "title": "The STRATTRIBUTE9 Schema",
"type" : "string",
+
      "default": "",
"title" : "The STRATTRIBUTE10 Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "STRATTRIBUTE10": {
},
+
      "$id": "#/properties/STRATTRIBUTE10",
"DATEATTRIBUTE1" : {
+
      "type": "string",
"$id" : "#/properties/DATEATTRIBUTE1",
+
      "title": "The STRATTRIBUTE10 Schema",
"type" : "string",
+
      "default": "",
"format" : "int64",
+
      "examples": []
"title" : "The DATEATTRIBUTE1 Schema",
+
    },
"default" : "",
+
    "DATEATTRIBUTE1": {
"examples" : [ ]
+
      "$id": "#/properties/DATEATTRIBUTE1",
},
+
      "type": "string",
"DATEATTRIBUTE2" : {
+
      "format": "int64",
"$id" : "#/properties/DATEATTRIBUTE2",
+
      "title": "The DATEATTRIBUTE1 Schema",
"type" : "string",
+
      "default": "",
"format" : "int64",
+
      "examples": []
"title" : "The DATEATTRIBUTE2 Schema",
+
    },
"default" : "",
+
    "DATEATTRIBUTE2": {
"examples" : [ ]
+
      "$id": "#/properties/DATEATTRIBUTE2",
},
+
      "type": "string",
"DATEATTRIBUTE3" : {
+
      "format": "int64",
"$id" : "#/properties/DATEATTRIBUTE3",
+
      "title": "The DATEATTRIBUTE2 Schema",
"type" : "string",
+
      "default": "",
"format" : "int64",
+
      "examples": []
"title" : "The DATEATTRIBUTE3 Schema",
+
    },
"default" : "",
+
    "DATEATTRIBUTE3": {
"examples" : [ ]
+
      "$id": "#/properties/DATEATTRIBUTE3",
},
+
      "type": "string",
"CREATEDDATE" : {
+
      "format": "int64",
"$id" : "#/properties/CREATEDDATE",
+
      "title": "The DATEATTRIBUTE3 Schema",
"type" : "string",
+
      "default": "",
"title" : "The CREATEDDATE Schema",
+
      "examples": []
"default" : "null",
+
    },
"examples" : [ {
+
    "CREATEDDATE": {
"CreatedDate" : "2010-04-30T12:03:30.133Z"
+
      "$id": "#/properties/CREATEDDATE",
}, {
+
      "type": "string",
"definition" : "Date and time in ISO 8601 standard"
+
      "title": "The CREATEDDATE Schema",
} ]
+
      "default": "null",
},
+
      "examples": [
"MODIFIEDDATE" : {
+
        {
"$id" : "#/properties/MODIFIEDDATE",
+
          "CreatedDate": "2010-04-30T12:03:30.133Z"
"type" : "string",
+
        },
"title" : "The MODIFIEDDATE Schema",
+
        {
"default" : "null",
+
          "definition": "Date and time in ISO 8601 standard"
"examples" : [ {
+
        }
"ModifiedDate" : "2010-04-30T12:03:30.133Z"
+
      ]
}, {
+
    },
"definition" : "Date and time in ISO 8601 standard"
+
    "MODIFIEDDATE": {
} ]
+
      "$id": "#/properties/MODIFIEDDATE",
},
+
      "type": "string",
"MERGEID" : {
+
      "title": "The MODIFIEDDATE Schema",
"$id" : "#/properties/MERGEID",
+
      "default": "null",
"type" : "string",
+
      "examples": [
"title" : "The MERGEID Schema",
+
        {
"default" : "",
+
          "ModifiedDate": "2010-04-30T12:03:30.133Z"
"examples" : [ ]
+
        },
},
+
        {
"SUBSCRIBERID" : {
+
          "definition": "Date and time in ISO 8601 standard"
"$id" : "#/properties/SUBSCRIBERID",
+
        }
"type" : "string",
+
      ]
"title" : "The SUBSCRIBERID Schema",
+
    },
"default" : "",
+
    "MERGEID": {
"examples" : [ ]
+
      "$id": "#/properties/MERGEID",
}
+
      "type": "string",
}
+
      "title": "The MERGEID Schema",
 +
      "default": "",
 +
      "examples": []
 +
    },
 +
    "SUBSCRIBERID": {
 +
      "$id": "#/properties/SUBSCRIBERID",
 +
      "type": "string",
 +
      "title": "The SUBSCRIBERID Schema",
 +
      "default": "",
 +
      "examples": []
 +
    }
 +
  }
 
}
 
}
 
</source>
 
</source>
Line 1,138: Line 1,306:
  
 
<source lang="text">
 
<source lang="text">
{"CONTACTID" : "00001a57JGQ00039",  
+
{
"STRATTRIBUTE4" : "Joseph",  
+
  "CONTACTID": "00001a57JGQ00039",
"TENANTID" : 101,  
+
  "STRATTRIBUTE4": "Joseph",
"CREATEDDATE" : "2009-08-05T08:30:25.467Z",  
+
  "TENANTID": 101,
"STRATTRIBUTE2" : "A.Joseph@mycompany.com",  
+
  "CREATEDDATE": "2009-08-05T08:30:25.467Z",
"MODIFIEDDATE" : "2009-08-05T08:30:25.513Z",  
+
  "STRATTRIBUTE2": "A.Joseph@mycompany.com",
"STRATTRIBUTE5" : "A"}
+
  "MODIFIEDDATE": "2009-08-05T08:30:25.513Z",
 +
  "STRATTRIBUTE5": "A"
 +
}
 
</source>
 
</source>
  
Line 1,155: Line 1,325:
 
<source lang="text">
 
<source lang="text">
 
{
 
{
"definitions" : { },
+
  "definitions": {},
"$schema" : "http://json-schema.org/draft-07/schema#",
+
  "$schema": "http://json-schema.org/draft-07/schema#",
"$id" : "http://genesys.com/gdps/schema/9.0.001.07/contactattribute.json",
+
  "$id": "http://genesys.com/gdps/schema/9.0.001.07/contactattribute.json",
"type" : "object",
+
  "type": "object",
"title" : "ContactAttribute schema",
+
  "title": "ContactAttribute schema",
"required" : [ ],
+
  "required": [],
"properties" : {
+
  "properties": {
"ID" : {
+
    "ID": {
"$id" : "#/properties/ID",
+
      "$id": "#/properties/ID",
"type" : "string",
+
      "type": "string",
"title" : "The ID Schema",
+
      "title": "The ID Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"CONTACTID" : {
+
    "CONTACTID": {
"$id" : "#/properties/CONTACTID",
+
      "$id": "#/properties/CONTACTID",
"type" : "string",
+
      "type": "string",
"title" : "The CONTACTID Schema",
+
      "title": "The CONTACTID Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"ATTRIBUTEID" : {
+
    "ATTRIBUTEID": {
"$id" : "#/properties/ATTRIBUTEID",
+
      "$id": "#/properties/ATTRIBUTEID",
"type" : "string",
+
      "type": "string",
"title" : "The ATTRIBUTEID Schema",
+
      "title": "The ATTRIBUTEID Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"ATTRIBUTENAME" : {
+
    "ATTRIBUTENAME": {
"$id" : "#/properties/ATTRIBUTENAME",
+
      "$id": "#/properties/ATTRIBUTENAME",
"type" : "string",
+
      "type": "string",
"title" : "The ATTRIBUTENAME Schema",
+
      "title": "The ATTRIBUTENAME Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"MIMETYPE" : {
+
    "MIMETYPE": {
"$id" : "#/properties/MIMETYPE",
+
      "$id": "#/properties/MIMETYPE",
"type" : "string",
+
      "type": "string",
"title" : "The MIMETYPE Schema",
+
      "title": "The MIMETYPE Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"STRVALUE" : {
+
    "STRVALUE": {
"$id" : "#/properties/STRVALUE",
+
      "$id": "#/properties/STRVALUE",
"type" : "string",
+
      "type": "string",
"title" : "The STRVALUE Schema",
+
      "title": "The STRVALUE Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"STRVALUELOWERCASE" : {
+
    "STRVALUELOWERCASE": {
"$id" : "#/properties/STRVALUELOWERCASE",
+
      "$id": "#/properties/STRVALUELOWERCASE",
"type" : "string",
+
      "type": "string",
"title" : "The STRVALUELOWERCASE Schema",
+
      "title": "The STRVALUELOWERCASE Schema",
"default" : "",
+
      "default": "",
"examples" : [ ]
+
      "examples": []
},
+
    },
"BINVALUE" : {
+
    "BINVALUE": {
"$id" : "#/properties/BINVALUE",
+
      "$id": "#/properties/BINVALUE",
"type" : "string",
+
      "type": "string",
"title" : "The BINVALUE Schema",
+
      "title": "The BINVALUE Schema",
"default" : "null",
+
      "default": "null",
"examples" : [ {
+
      "examples": [
"definition" : "Binary content (png, jpg,...) encoded as base64"
+
        {
} ]
+
          "definition": "Binary content (png, jpg,...) encoded as base64"
},
+
        }
"DATEVALUE" : {
+
      ]
"$id" : "#/properties/DATEVALUE",
+
    },
"type" : "string",
+
    "DATEVALUE": {
"title" : "The DATEVALUE Schema",
+
      "$id": "#/properties/DATEVALUE",
"default" : "null",
+
      "type": "string",
"examples" : [ {
+
      "title": "The DATEVALUE Schema",
"DateValue" : "2010-04-30T12:03:30.133Z"
+
      "default": "null",
}, {
+
      "examples": [
"definition" : "Date and time in ISO 8601 standard"
+
        {
} ]
+
          "DateValue": "2010-04-30T12:03:30.133Z"
},
+
        },
"DESCRIPTION" : {
+
        {
"$id" : "#/properties/DESCRIPTION",
+
          "definition": "Date and time in ISO 8601 standard"
"type" : "string",
+
        }
"title" : "The DESCRIPTION Schema",
+
      ]
"default" : "",
+
    },
"examples" : [ ]
+
    "DESCRIPTION": {
},
+
      "$id": "#/properties/DESCRIPTION",
"ISPRIMARY" : {
+
      "type": "string",
"$id" : "#/properties/ISPRIMARY",
+
      "title": "The DESCRIPTION Schema",
"type" : "integer",
+
      "default": "",
"title" : "The ISPRIMARY Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "ISPRIMARY": {
},
+
      "$id": "#/properties/ISPRIMARY",
"TENANTID" : {
+
      "type": "integer",
"$id" : "#/properties/TENANTID",
+
      "title": "The ISPRIMARY Schema",
"type" : "integer",
+
      "default": "",
"title" : "The TENANTID Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "TENANTID": {
},
+
      "$id": "#/properties/TENANTID",
"SUBTENANTID" : {
+
      "type": "integer",
"$id" : "#/properties/SUBTENANTID",
+
      "title": "The TENANTID Schema",
"type" : "integer",
+
      "default": "",
"title" : "The SUBTENANTID Schema",
+
      "examples": []
"default" : "",
+
    },
"examples" : [ ]
+
    "SUBTENANTID": {
}
+
      "$id": "#/properties/SUBTENANTID",
}
+
      "type": "integer",
 +
      "title": "The SUBTENANTID Schema",
 +
      "default": "",
 +
      "examples": []
 +
    }
 +
  }
 
}
 
}
 
</source>
 
</source>
Line 1,270: Line 1,445:
  
 
<source lang="text">
 
<source lang="text">
{"ID" : "00001a57JGQ0003A",  
+
{
"CONTACTID" : "00001a57JGQ00039",  
+
  "ID": "00001a57JGQ0003A",
"STRVALUELOWERCASE" : "joseph",  
+
  "CONTACTID": "00001a57JGQ00039",
"ISPRIMARY" : 1,  
+
  "STRVALUELOWERCASE": "joseph",
"ATTRIBUTEID" : "00001a57JGQ00008",  
+
  "ISPRIMARY": 1,
"STRVALUE" : "Joseph",  
+
  "ATTRIBUTEID": "00001a57JGQ00008",
"ATTRIBUTENAME" : "LastName"}
+
  "STRVALUE": "Joseph",
 +
  "ATTRIBUTENAME": "LastName"
 +
}
 
</source>
 
</source>
  

Revision as of 00:35, October 31, 2019

Contact History Export Reference

This page contains information about how the data files for Contact History export jobs are formatted and structured.

The exported data files are formatted in JSON (JavaScript Object Notation) Lines format. In this type of format, each line in the file corresponds to one interaction or contacts attribute, represented as a JSON object with keys and values.

For example, an entry in a contact export might look like this:

{"ContactId":"00001a57JGQ00A8TZSA","tenantid":101,"createddate":"2015-08-05 08:31:20.78"}

The way that the data fields and values are organized in each export file is controlled by a schema. The schemas used by CDDS are based on JSON Schema (draft 7). You can learn more about JSON Schema by visiting their website.

The following sections provide the schemas used for each type of export job and include some examples of exported data.

Important
The examples provided for each export file have been formatted for easier viewing. In an actual export file, the data is displayed as a single-line, with each key-value pair separated by a comma.

Interactions

Interaction data contains details about interactions that were processed during the time period specified in the job settings, such as voice calls, chats, and emails. When CDDS exports this data, all of the data records for each interaction type are merged into a single export file:

<EntityType>-<jobId>.json

In addition to data values, interaction data may also include attached files (such as attachments in email interactions). The contents of these file attachments are exported in a separate file that uses a document schema:

<EntityType>-Attachment-<jobId>.json

You can associate interactions with their file attachments by cross-referencing the id field in the interaction export with the entityid field in the related document export file.

Important
Schema files are created only if there is corresponding data being exported. For example, if there are no documents being exported, no document schema is generated.

Interaction schema

[+] Click to show

Example of an Interaction export

[+] Click to show

Document schema

[+] Click to show

Example of a Document export

[+] Click to show

AllAttributes field format

The AllAttributes field is part of the interactions export data and contains a special collection of key-value pairs. The field holds a list of objects in the following format, where key is a string identifier and data is a JSON type (such as string, integer, or other valid JSON object).

{ "<key>" : <data> }

Example of AllAttributes export

[+] Click to show

Contacts

Contact data export files contain details about each customer, such as their name, customer ID, email address, and the date that their contact information was created or modified.

Contact Attributes are associated with a particular contact and, like documents (i.e. attachments) for interactions, are exported in a separate file that uses a different schema.

Contact schema

[+] Click to show

Example of a Contact export

[+] Click to show

Contact Attributes schema

[+] Click to show

Example of a Contact Attributes export

[+] Click to show

Comments or questions about this documentation? Contact us for support!