{
"openapi" : "3.1.0",
"info" : {
"title" : "Search",
"version" : "1.0.0"
},
"paths" : {
"/api/v1/tickets/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Tickets",
"description" : "This API searches for tickets in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchTickets",
"x-mcp-group" : [ "Search", "Tickets" ],
"parameters" : [ {
"name" : "email",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"minLength" : 3
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "The corresponding email address associated with the ticket. example: 1. email=jack* 2.email=${notempty} 3.email=${empty} !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "phone",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\*\\$@\\?\\{\\}\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]",
"x-regex-name" : "inv_clrtxtpatrn_phoneWithAsterisk",
"minLength" : 3
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "The phone number provided in the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "ticketNumber",
"in" : "query",
"description" : "The ticket's serial number !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int32",
"description" : "The ticket's serial number !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "accountName",
"in" : "query",
"description" : "Name of the account associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 500,
"minLength" : 3,
"description" : "Name of the account associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
}
}, {
"name" : "subject",
"in" : "query",
"description" : "Subject of the ticket !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Subject of the ticket !@wildcard search@!"
}
}, {
"name" : "departmentId",
"in" : "query",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
}
}, {
"name" : "productName",
"in" : "query",
"description" : "Name of the product associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 500,
"minLength" : 3,
"description" : "Name of the product associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string" ],
"maxLength" : 100,
"minLength" : 3
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "dueDateRange",
"in" : "query",
"description" : "Key that filters tickets due in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! dueDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets due in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! dueDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "id",
"in" : "query",
"description" : "ID of the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 100,
"format" : "int64",
"description" : "ID of the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "productId",
"in" : "query",
"description" : "ID of the product associated with the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int64",
"description" : "ID of the product associated with the ticket !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "contactId",
"in" : "query",
"description" : "ID of the contact who raised the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int64",
"description" : "ID of the contact who raised the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "priority",
"in" : "query",
"description" : "Priority of the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"description" : "Priority of the ticket",
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 30,
"description" : "Priority of the ticket !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "assigneeId",
"in" : "query",
"description" : "ID of the agent who is assigned to resolve the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"description" : "ID of agent to whom the ticket is assigned",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int64",
"description" : "ID of the agent who is assigned to resolve the ticket !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "accountId",
"in" : "query",
"description" : "ID of the account associated with the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int64",
"description" : "ID of the account associated with the ticket !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "status",
"in" : "query",
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 100,
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "fields",
"in" : "query",
"required" : false,
"description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @webUrl@, @layoutId@. Maximum of 34 fields is supported as comma separated values. When omitted or empty, the full permitted response is returned.",
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})"
},
"maxItems" : 34
},
"style" : "form",
"explode" : false
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "customField1",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format.!@customfield1=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField2",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield2=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField3",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield3=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField4",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield4=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField5",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield5=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField6",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield6=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField7",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield7=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField8",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield8=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField9",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield9=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField10",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield10=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "channel",
"in" : "query",
"description" : "The channel through which the ticket was received !@exact match@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"x-dynamic-enum" : true,
"minLength" : 3,
"pattern" : "([0-9a-zA-Z_\\-\\*\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+|\\$\\{(?i)(Empty|NotEmpty)\\})"
},
"maxItems" : 30
}
}, {
"name" : "customerResponseTimeRange",
"in" : "query",
"description" : "Key that filters tickets in which customer responses were recorded in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! customerResponseTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z2017-11-05T13:15:30.000Z,2018-09-05T13:15:30.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "Key that filters tickets in which customer responses were recorded in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! customerResponseTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z2017-11-05T13:15:30.000Z,2018-09-05T13:15:30.000Z",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null"
}
}, {
"name" : "description",
"in" : "query",
"description" : "Description of the ticket !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "Description of the ticket !@wildcard search@!",
"maxLength" : 1000,
"minLength" : 3
}
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@customerResponseTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@customerResponseTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime", "customerResponseTime", "closedTime", "dueDate" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime|customerResponseTime|closedTime|dueDate)"
}
}, {
"name" : "tag",
"in" : "query",
"description" : "The tag associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"maxLength" : 100,
"minLength" : 3,
"pattern" : "([0-9a-zA-Z_\\-\\*\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+|\\$\\{(?i)(Empty|NotEmpty)\\})"
},
"maxItems" : 30
}
}, {
"name" : "contactName",
"in" : "query",
"description" : "The name of the contact who raised the ticket !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The name of the contact who raised the ticket !@wildcard search@!",
"maxLength" : 500,
"minLength" : 3
}
}, {
"name" : "category",
"in" : "query",
"description" : "The category of the ticket !@wildcard search@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"minLength" : 3,
"x-dynamic-enum" : true,
"pattern" : "([0-9a-zA-Z_\\-\\*\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+|\\$\\{(?i)(Empty|NotEmpty)\\})"
},
"maxItems" : 30
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchTicketsResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.tickets.READ", "Desk.search.READ" ]
} ]
}
},
"/api/v1/{moduleApiName}/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Records",
"description" : "This API searches for records in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchRecords",
"x-mcp-group" : [ "Search", "Custom Modules" ],
"parameters" : [ {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "field1",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field1=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "field2",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field2=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "field3",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field3=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "field4",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field4=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "field5",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field5=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "field6",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field6=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "field7",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field7=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "field8",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field8=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "field9",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field9=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "field10",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@field10=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime)"
}
}, {
"name" : "moduleApiName",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"maxLength" : 100,
"minLength" : 5,
"pattern" : "(cm_[a-zA-Z0-9_]+)"
}
}, {
"name" : "fields",
"in" : "query",
"required" : false,
"description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @webUrl@, @layoutId@. Maximum of 34 fields is supported as comma separated values. When omitted or empty, the full permitted response is returned.",
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})"
},
"maxItems" : 34
},
"style" : "form",
"explode" : false
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchRecordsResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.custommodule.READ", "Desk.search.READ" ]
} ]
}
},
"/api/v1/calls/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Calls",
"description" : "This API searches for the calls in your help desk portal.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchCalls",
"x-mcp-group" : [ "Search", "Calls" ],
"parameters" : [ {
"name" : "assigneeId",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "ID of the agent assigned to handle the call !@exact match@!"
}, {
"name" : "ticketNumber",
"in" : "query",
"description" : "The ticket's serial number !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int32",
"description" : "The ticket's serial number !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "startDateRange",
"in" : "query",
"description" : "Key that filters calls that were made in a particular period. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! startDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters calls that were made in a particular period. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! startDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "subject",
"in" : "query",
"description" : "Subject of the ticket !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Subject of the ticket !@wildcard search@!"
}
}, {
"name" : "departmentId",
"in" : "query",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
}
}, {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "priority",
"in" : "query",
"description" : "Priority of the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"description" : "Priority of the ticket",
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 30,
"description" : "Priority of the ticket !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "id",
"in" : "query",
"description" : "ID of the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 100,
"format" : "int64",
"description" : "ID of the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "status",
"in" : "query",
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 100,
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "fields",
"in" : "query",
"required" : false,
"description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @webUrl@, @layoutId@. Maximum of 34 fields is supported as comma separated values. When omitted or empty, the full permitted response is returned.",
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})"
},
"maxItems" : 34
},
"style" : "form",
"explode" : false
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "customField1",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield1=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField2",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield2=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField3",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield3=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField4",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield4=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField5",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield5=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField6",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield6=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField7",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield7=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField8",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield8=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField9",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield9=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField10",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield10=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime)"
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchCallsResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.activities.calls.READ", "Desk.search.READ" ]
}, {
"deprecated-iam-oauth2-schema" : [ "Desk.calls.READ" ]
} ]
}
},
"/api/v1/accounts/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Accounts",
"description" : "This API searches for accounts in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchAccounts",
"x-mcp-group" : [ "Accounts", "Search" ],
"parameters" : [ {
"name" : "accountName",
"in" : "query",
"description" : "Name of the account associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 500,
"minLength" : 3,
"description" : "Name of the account associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
}
}, {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "id",
"in" : "query",
"description" : "ID of the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 100,
"format" : "int64",
"description" : "ID of the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
}, {
"name" : "fields",
"in" : "query",
"required" : false,
"description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @webUrl@, @layoutId@. Maximum of 34 fields is supported as comma separated values. When omitted or empty, the full permitted response is returned.",
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})"
},
"maxItems" : 34
},
"style" : "form",
"explode" : false
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "customField1",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield1=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! e.g customField1=cf_activeAccount:true !@empty check@! e.g customField1=cf_activeAccount:${empty} !@not empty check@!"
}, {
"name" : "customField2",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield2=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@! e.g customField2=cf_activeAccount:${notempty}"
}, {
"name" : "customField3",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield3=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField4",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield4=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField5",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield5=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField6",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield6=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField7",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield7=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField8",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield8=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField9",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield9=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField10",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield10=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@accountName@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@accountName@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime", "accountName" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime|accountName)"
}
}, {
"name" : "startsWith",
"in" : "query",
"description" : "account Name startsWith !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "account Name startsWith !@wildcard search@!",
"maxLength" : 100
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchAccountsResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.accounts.READ", "Desk.search.READ" ]
}, {
"deprecated-iam-oauth2-schema" : [ "Desk.contacts.READ" ]
} ]
}
},
"/api/v1/articles/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Articles",
"description" : "This API searches for help articles in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchSolutions",
"x-mcp-group" : [ "Search", "KB Admin", "KB Dashboard", "Manage KB Category", "Manage KB Moderation", "View KB Moderation", "Manage KB Recyclebin", "View KB Recyclebin", "Manage KB Articles", "View KB Articles", "Manage KB Feedbacks", "View KB Feedbacks", "View KB" ],
"parameters" : [ {
"name" : "categoryName",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ]
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "Name of the Category !@wildcard search@!"
}, {
"name" : "tag",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\*\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+|\\$\\{(?i)(Empty|NotEmpty)\\})",
"x-regex-name" : "customOperationPicklistValue"
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "Tag in the articles !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "departmentId",
"in" : "query",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
}
}, {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "id",
"in" : "query",
"description" : "ID of the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 100,
"format" : "int64",
"description" : "ID of the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime)"
}
}, {
"name" : "title",
"in" : "query",
"description" : "title of the help article !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "title of the help article !@wildcard search@!",
"maxLength" : 1000,
"minLength" : 3
}
}, {
"name" : "categoryId",
"in" : "query",
"description" : "ID of the Category ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"description" : "ID of the Category ",
"pattern" : "([0-9]+)"
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchSolutionsResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.articles.READ", "Desk.search.READ" ]
} ]
}
},
"/api/v1/products/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Products",
"description" : "This API searches for the products in your help desk portal.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchProducts",
"x-mcp-group" : [ "Search", "Products" ],
"parameters" : [ {
"name" : "contactId",
"in" : "query",
"description" : "ID of the contact who raised the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int64",
"description" : "ID of the contact who raised the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "departmentId",
"in" : "query",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
}
}, {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "productName",
"in" : "query",
"description" : "Name of the product associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 500,
"minLength" : 3,
"description" : "Name of the product associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
}, {
"name" : "accountId",
"in" : "query",
"description" : "ID of the account associated with the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int64",
"description" : "ID of the account associated with the ticket !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "id",
"in" : "query",
"description" : "ID of the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 100,
"format" : "int64",
"description" : "ID of the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "fields",
"in" : "query",
"required" : false,
"description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @webUrl@, @layoutId@. Maximum of 34 fields is supported as comma separated values. When omitted or empty, the full permitted response is returned.",
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})"
},
"maxItems" : 34
},
"style" : "form",
"explode" : false
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "customField1",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield1=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField2",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield2=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField3",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield3=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField4",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield4=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField5",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield5=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField6",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield6=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField7",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield7=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField8",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield8=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField9",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield9=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField10",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield10=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "productCode",
"in" : "query",
"description" : "Code of the product !@wildcard search@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"maxLength" : 100,
"minLength" : 3
},
"maxItems" : 30
}
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@productName@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@productName@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime", "productName" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime|productName)"
}
}, {
"name" : "startsWith",
"in" : "query",
"description" : "account Name startsWith !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "account Name startsWith !@wildcard search@!",
"maxLength" : 100
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchProductsResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.products.READ", "Desk.search.READ" ]
}, {
"deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ]
} ]
}
},
"/api/v1/contacts/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Contacts",
"description" : "This API searches for contacts in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchContacts",
"x-mcp-group" : [ "Contacts" ],
"parameters" : [ {
"name" : "email",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"minLength" : 3
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "Email ID of the contact !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "phone",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\*\\$@\\?\\{\\}\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]",
"x-regex-name" : "inv_clrtxtpatrn_phoneWithAsterisk",
"minLength" : 3
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "Phone number of the contact !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "mobile",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\*\\$@\\?\\{\\}\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]",
"x-regex-name" : "inv_clrtxtpatrn_phoneWithAsterisk",
"minLength" : 3
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "Mobile number of the contact !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "accountName",
"in" : "query",
"description" : "Name of the account associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 500,
"minLength" : 3,
"description" : "Name of the account associated with the ticket !@wildcard search@! !@empty check@! !@not empty check@!"
}
}, {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "id",
"in" : "query",
"description" : "ID of the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 100,
"format" : "int64",
"description" : "ID of the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
}, {
"name" : "fields",
"in" : "query",
"required" : false,
"description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @webUrl@, @layoutId@. Maximum of 34 fields is supported as comma separated values. When omitted or empty, the full permitted response is returned.",
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})"
},
"maxItems" : 34
},
"style" : "form",
"explode" : false
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "customField1",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield1=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! e.g customField1=cf_mappedWithAccount:true !@empty check@! e.g customField1=cf_mappedWithAccount:${empty} !@not empty check@!"
}, {
"name" : "customField2",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield2=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@! e.g customField2=cf_mappedWithAccount:${notempty}"
}, {
"name" : "customField3",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield3=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField4",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield4=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField5",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield5=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField6",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield6=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField7",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield7=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField8",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield8=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField9",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield9=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField10",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield10=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "lastName",
"in" : "query",
"description" : "Last name of the contact !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "Last name of the contact !@wildcard search@!",
"maxLength" : 500,
"minLength" : 3
}
}, {
"name" : "firstName",
"in" : "query",
"description" : "First name of the contact !@wildcard search@! !@empty check@! !@not empty check@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "First name of the contact !@wildcard search@! !@empty check@! !@not empty check@!",
"maxLength" : 500,
"minLength" : 3
}
}, {
"name" : "fullName",
"in" : "query",
"description" : "Full name of the contact !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "Full name of the contact !@wildcard search@!",
"maxLength" : 500,
"minLength" : 3
}
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@lastName@,! !@firstName@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@,! !@lastName@,! !@firstName@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime", "lastName", "firstName" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime|lastName|firstName)"
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchContactsResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.contacts.READ", "Desk.search.READ" ]
} ]
}
},
"/api/v1/activities/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Activities",
"description" : "This API searches for the activities in your help desk portal.
You can provide comma-separated values, which will perform the search on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchActivities",
"x-mcp-group" : [ "Search" ],
"parameters" : [ {
"name" : "ticketNumber",
"in" : "query",
"description" : "The ticket's serial number !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int32",
"description" : "The ticket's serial number !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "subject",
"in" : "query",
"description" : "Subject of the ticket !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Subject of the ticket !@wildcard search@!"
}
}, {
"name" : "departmentId",
"in" : "query",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
}
}, {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "priority",
"in" : "query",
"description" : "Priority of the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"description" : "Priority of the ticket",
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 30,
"description" : "Priority of the ticket !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "assigneeId",
"in" : "query",
"description" : "ID of the agent who is assigned to resolve the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"description" : "ID of agent to whom the ticket is assigned",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int64",
"description" : "ID of the agent who is assigned to resolve the ticket !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "id",
"in" : "query",
"description" : "ID of the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 100,
"format" : "int64",
"description" : "ID of the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "status",
"in" : "query",
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 100,
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "fields",
"in" : "query",
"required" : false,
"description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @webUrl@, @layoutId@. Maximum of 34 fields is supported as comma separated values. When omitted or empty, the full permitted response is returned.",
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})"
},
"maxItems" : 34
},
"style" : "form",
"explode" : false
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime)"
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/activitiesSearchResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.activities.calls.READ", "Desk.activities.events.READ", "Desk.activities.tasks.READ", "Desk.search.READ" ]
}, {
"deprecated-iam-oauth2-schema" : [ "Desk.calls.READ", "Desk.events.READ", "Desk.tasks.READ" ]
} ]
}
},
"/api/v1/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search across modules",
"description" : "This API returns information from all modules or a specific module, based on the value of the module query param.",
"operationId" : "doSearch",
"x-mcp-group" : [ "Search" ],
"parameters" : [ {
"name" : "departmentId",
"in" : "query",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "searchStr",
"in" : "query",
"description" : "Keyword or phrase to search",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "Keyword or phrase to search",
"maxLength" : 200
}
}, {
"name" : "module",
"in" : "query",
"description" : "Module to search in: @tickets@, @accounts@, @contacts@ or @tasks@. The default response includes all modules.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "Module to search in: @tickets@, @accounts@, @contacts@ or @tasks@. The default response includes all modules.",
"enum" : [ "tickets", "contacts", "accounts", "tasks" ],
"maxLength" : 100
}
}, {
"name" : "sortBy",
"in" : "query",
"description" : "Sort by a specific attribute: @relevance@ or @modifiedTime@",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "Sort by a specific attribute: @relevance@ or @modifiedTime@",
"enum" : [ "relevance", "modifiedTime" ],
"maxLength" : 100
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/doSearchResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.accounts.READ", "Desk.activities.tasks.READ", "Desk.contacts.READ", "Desk.search.READ", "Desk.tickets.READ" ]
}, {
"deprecated-iam-oauth2-schema" : [ "Desk.tasks.READ" ]
} ]
}
},
"/api/v1/tasks/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Tasks",
"description" : "This API searches for tasks in your help desk.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchTasks",
"x-mcp-group" : [ "Search", "Tasks" ],
"parameters" : [ {
"name" : "assigneeId",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "ID of the agent assigned to resolve the task !@exact match@!"
}, {
"name" : "ticketNumber",
"in" : "query",
"description" : "The ticket's serial number !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int32",
"description" : "The ticket's serial number !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "subject",
"in" : "query",
"description" : "Subject of the ticket !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Subject of the ticket !@wildcard search@!"
}
}, {
"name" : "departmentId",
"in" : "query",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
}
}, {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "priority",
"in" : "query",
"description" : "Priority of the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"description" : "Priority of the ticket",
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 30,
"description" : "Priority of the ticket !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "dueDateRange",
"in" : "query",
"description" : "Key that filters tickets due in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! dueDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets due in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! dueDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "id",
"in" : "query",
"description" : "ID of the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 100,
"format" : "int64",
"description" : "ID of the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "status",
"in" : "query",
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 100,
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "fields",
"in" : "query",
"required" : false,
"description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @webUrl@, @layoutId@. Maximum of 34 fields is supported as comma separated values. When omitted or empty, the full permitted response is returned.",
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})"
},
"maxItems" : 34
},
"style" : "form",
"explode" : false
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "customField1",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield1=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField2",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield2=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField3",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield3=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField4",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield4=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField5",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield5=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField6",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield6=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField7",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield7=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField8",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield8=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField9",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield9=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField10",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield10=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime)"
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchTasksResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.activities.tasks.READ", "Desk.search.READ" ]
}, {
"deprecated-iam-oauth2-schema" : [ "Desk.activities.calls.READ", "Desk.activities.events.READ", "Desk.tasks.READ" ]
} ]
}
},
"/api/v1/events/search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search Events",
"description" : "This API searches for the events in your help desk portal.
You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.
Learn more about search and how it works.",
"operationId" : "searchEvents",
"x-mcp-group" : [ "Search", "Events" ],
"parameters" : [ {
"name" : "assigneeId",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"maxItems" : 30
},
"style" : "form",
"explode" : true,
"description" : "ID of the agent assigned to handle the event !@exact match@!"
}, {
"name" : "ticketNumber",
"in" : "query",
"description" : "The ticket's serial number !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 30,
"format" : "int32",
"description" : "The ticket's serial number !@exact match@!",
"pattern" : "([0-9]+)"
}
}, {
"name" : "startDateRange",
"in" : "query",
"description" : "Key that filters calls that were made in a particular period. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! startDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters calls that were made in a particular period. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! startDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "subject",
"in" : "query",
"description" : "Subject of the ticket !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Subject of the ticket !@wildcard search@!"
}
}, {
"name" : "departmentId",
"in" : "query",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
}
}, {
"name" : "createdTimeRange",
"in" : "query",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets created in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "priority",
"in" : "query",
"description" : "Priority of the ticket !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"description" : "Priority of the ticket",
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 30,
"description" : "Priority of the ticket !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "_all",
"in" : "query",
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 1000,
"minLength" : 3,
"description" : "Key that includes all the columns in the tickets module for search !@wildcard search@!"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "modifiedTimeRange",
"in" : "query",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null",
"description" : "Key that filters tickets modified in a particular period of time. !Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ;! !For example,! modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z"
}
}, {
"name" : "id",
"in" : "query",
"description" : "ID of the ticket !@exact match@! ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"minLength" : 3
},
"maxItems" : 100,
"format" : "int64",
"description" : "ID of the ticket !@exact match@! ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "status",
"in" : "query",
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"x-dynamic-enum" : true,
"minLength" : 3
},
"maxItems" : 100,
"description" : "Status of the ticket inclusive of custom status. example: 1. status=open,in progress 2. status=${open} !@exact match@!",
"x-dynamic-enum" : true
}
}, {
"name" : "fields",
"in" : "query",
"required" : false,
"description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @webUrl@, @layoutId@. Maximum of 34 fields is supported as comma separated values. When omitted or empty, the full permitted response is returned.",
"schema" : {
"type" : [ "array" ],
"items" : {
"type" : [ "string" ],
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})"
},
"maxItems" : 34
},
"style" : "form",
"explode" : false
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
}, {
"name" : "customField1",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield1=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField2",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield2=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField3",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield3=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField4",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield4=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField5",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield5=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField6",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield6=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField7",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield7=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField8",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield8=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField9",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield9=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "customField10",
"in" : "query",
"required" : false,
"schema" : {
"type" : [ "string" ],
"maxLength" : 1000,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+):.*"
},
"description" : "To search for the values in a field, use the below format. !@customfield10=Field ApiName:search value@! This will compare the specified search values with the field's value and retrieve the matching results. !@wildcard search@! !@empty check@! !@not empty check@!"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "SortBy can be: !@relevance@,! !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "relevance", "modifiedTime", "createdTime" ],
"maxLength" : 100,
"pattern" : "-?(relevance|modifiedTime|createdTime)"
}
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchEventsResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.activities.events.READ", "Desk.search.READ" ]
}, {
"deprecated-iam-oauth2-schema" : [ "Desk.events.READ" ]
} ]
}
},
"/api/v1/Solutions/Search" : {
"get" : {
"tags" : [ "Search" ],
"summary" : "Search solutions",
"description" : "Searches solutions.",
"operationId" : "searchLegacySolutions",
"parameters" : [ {
"name" : "departmentId",
"in" : "query",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "ID of the department from which the entity must be fetched. If the ID is not passed, then searches in all permitted departments !@exact match@!"
}
}, {
"name" : "limit",
"in" : "query",
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"minimum" : 1,
"pattern" : "([0-9]+)",
"maximum" : 100,
"default" : 10,
"description" : "Specifies the number of tickets to be fetched. !@default : 10@!"
}
}, {
"name" : "from",
"in" : "query",
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "integer", "string" ],
"format" : "int32",
"pattern" : "([0-9]+)",
"minimum" : 0,
"maximum" : 999,
"default" : 0,
"description" : "The starting index for fetching results. !@default : 0@! !@starts from 0@!"
}
}, {
"name" : "sortBy",
"in" : "query",
"description" : "SortBy can be: !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string" ],
"description" : "SortBy can be: !@modifiedTime@,! !@createdTime@! To specify sorting order, use as given below: !For descending order: sortBy=@-@modifiedTime! !For ascending order: sortBy=modifiedTime!",
"enum" : [ "modifiedTime", "createdTime" ],
"maxLength" : 100,
"pattern" : "[+-]?(createdTime|modifiedTime)"
}
}, {
"name" : "categoryId",
"in" : "query",
"description" : "ID of the Category ",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "string", "integer" ],
"format" : "int64",
"description" : "ID of the Category ",
"pattern" : "([0-9]+)"
}
}, {
"name" : "searchChar",
"in" : "query",
"description" : "Search string used to filter articles",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"maxLength" : 100,
"x-regex-name" : "cleartextampersand"
}
}, {
"name" : "isFetchCategory",
"in" : "query",
"description" : "Whether category details must be fetched along with the search results",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "boolean" ]
}
}, {
"name" : "viewAsPortalUser",
"in" : "query",
"description" : "Whether the search results must be fetched as viewed by a portal user",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : [ "boolean" ]
}
}, {
"$ref" : "./Common.json#/components/parameters/orgId"
} ],
"responses" : {
"422" : {
"$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
},
"204" : {
"$ref" : "./Common.json#/components/responses/emptyResponse"
},
"200" : {
"$ref" : "#/components/responses/searchSolutionsResponse"
}
},
"security" : [ {
"iam-oauth2-schema" : [ "Desk.articles.READ" ]
} ]
}
}
},
"components" : {
"schemas" : {
"subModuleAccountFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"website" : {
"type" : [ "string", "null" ],
"maxLength" : 120,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[0-9a-zA-Z][-.\\w]*(:[0-9])*(/?)([a-zA-Z0-9\\-\\.\\?\\,|\\:\\'\\/\\+=&%\\$#_\\[\\]@!\\(\\)\\*;~]*)?$)|[*]"
},
"accountName" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "accountName", "id", "website" ]
},
"ticketContactFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"lastName" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0
},
"firstName" : {
"type" : [ "string", "null" ],
"maxLength" : 40,
"minLength" : 0
},
"phone" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
},
"mobile" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"type" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"email" : {
"type" : [ "string", "null" ],
"maxLength" : 255,
"minLength" : 0,
"pattern" : "^[\\p{L}\\p{M}\\p{N}\\_]([\\p{L}\\p{M}\\p{N}\\_\\+\\-\\.\\'&\\!\\~]*)@(?=.{4,256}$)(([\\p{L}\\p{N}\\p{M}]+)(([\\-\\_]*[\\p{L}\\p{N}\\p{M}])*)[\\.])+[\\p{L}\\p{M}]{2,22}$"
},
"account" : {
"$ref" : "#/components/schemas/subModuleAccountFields"
}
},
"required" : [ "account", "email", "firstName", "id", "lastName", "mobile", "phone", "type" ]
},
"lastThread" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"channel" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"isDraft" : {
"type" : [ "boolean", "null" ]
},
"isForward" : {
"type" : [ "boolean", "null" ]
},
"direction" : {
"type" : [ "string", "null" ],
"enum" : [ "in", "out" ],
"maxLength" : 100,
"minLength" : 0
}
},
"required" : [ "channel", "direction", "isDraft", "isForward" ]
},
"assigneeFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"firstName" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 0
},
"photoURL" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"lastName" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 0
},
"emailId" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"zuid" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
}
},
"required" : [ "emailId", "firstName", "id", "lastName", "photoURL", "zuid" ]
},
"departmentFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "id", "name" ]
},
"teamFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 1,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"logoUrl" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
}
},
"required" : [ "id", "logoUrl", "name" ]
},
"subModuleProductFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"productName" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0
}
},
"required" : [ "id", "productName" ]
},
"searchTicketResponseFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"modifiedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"subCategory" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"statusType" : {
"type" : [ "string", "null" ],
"enum" : [ "Open", "Closed", "On Hold" ],
"maxLength" : 100,
"minLength" : 0
},
"subject" : {
"type" : [ "string", "null" ],
"maxLength" : 1000,
"minLength" : 0
},
"dueDate" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"departmentId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"channel" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"onholdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"language" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"sharedDepartments" : {
"$ref" : "./Ticket.json#/components/schemas/sharedDepartmentsWithNameArr"
},
"resolution" : {
"type" : [ "string", "null" ],
"maxLength" : 65535,
"minLength" : 0
},
"closedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"isOverDue" : {
"type" : [ "boolean", "null" ]
},
"contact" : {
"$ref" : "#/components/schemas/ticketContactFields"
},
"createdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"customerResponseTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"productId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"contactId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"threadCount" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
},
"secondaryContacts" : {
"type" : [ "array", "null" ],
"items" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"uniqueItems" : false
},
"priority" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"classification" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"commentCount" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
},
"accountId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"phone" : {
"type" : [ "string", "null" ],
"maxLength" : 120,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
},
"webUrl" : {
"type" : [ "string", "null" ],
"maxLength" : 500,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"assignee" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"isSpam" : {
"type" : [ "boolean", "null" ]
},
"childTicketCount" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
},
"status" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"entitySkills" : {
"type" : [ "array", "null" ],
"items" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"uniqueItems" : false
},
"ticketNumber" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
},
"customFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"isArchived" : {
"type" : [ "boolean", "null" ]
},
"isRead" : {
"type" : [ "boolean", "null" ]
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 65535,
"minLength" : 0
},
"responseDueDate" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"modifiedBy" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"department" : {
"$ref" : "#/components/schemas/departmentFields"
},
"email" : {
"type" : [ "string", "null" ],
"maxLength" : 150,
"minLength" : 0,
"pattern" : "^[\\p{L}\\p{M}\\p{N}\\_]([\\p{L}\\p{M}\\p{N}\\_\\+\\-\\.\\'&\\!\\~]*)@(?=.{4,256}$)(([\\p{L}\\p{N}\\p{M}]+)(([\\-\\_]*[\\p{L}\\p{N}\\p{M}])*)[\\.])+[\\p{L}\\p{M}]{2,22}$"
},
"product" : {
"$ref" : "#/components/schemas/subModuleProductFields"
},
"cf" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"slaId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"lastThread" : {
"$ref" : "#/components/schemas/lastThread"
},
"team" : {
"$ref" : "#/components/schemas/teamFields"
},
"assigneeId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"layoutId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"createdBy" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"teamId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"isEscalated" : {
"type" : [ "boolean", "null" ]
},
"category" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"relationshipType" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"parentTicket" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"description" : "Parent ticket associated with this ticket",
"properties" : {
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "Unique ID"
}
}
},
"sourceTicket" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"description" : "The source ticket for this ticket. Only a locked ticket can be specified as the source ticket.",
"properties" : {
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)",
"description" : "Unique ID"
}
}
},
"lockedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))",
"description" : "Time at which the ticket was locked"
}
},
"required" : [ "accountId", "assignee", "assigneeId", "category", "cf", "channel", "childTicketCount", "classification", "closedTime", "commentCount", "contact", "contactId", "createdBy", "createdTime", "customFields", "customerResponseTime", "department", "departmentId", "description", "dueDate", "email", "entitySkills", "id", "isArchived", "isEscalated", "isOverDue", "isRead", "isSpam", "language", "lastThread", "layoutId", "modifiedBy", "modifiedTime", "onholdTime", "phone", "priority", "product", "productId", "resolution", "responseDueDate", "secondaryContacts", "sharedDepartments", "slaId", "status", "statusType", "subCategory", "subject", "team", "teamId", "threadCount", "ticketNumber", "webUrl" ]
},
"searchTicketsData" : {
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/components/schemas/searchTicketResponseFields"
}
},
"activityModuleContactFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"firstName" : {
"type" : [ "string", "null" ],
"maxLength" : 40,
"minLength" : 0
},
"lastName" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0
},
"accountId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"phone" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
},
"mobile" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"isSpam" : {
"type" : [ "boolean", "null" ]
},
"email" : {
"type" : [ "string", "null" ],
"maxLength" : 255,
"minLength" : 0,
"pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
},
"secId" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
}
},
"required" : [ "accountId", "email", "firstName", "id", "isSpam", "lastName", "mobile", "phone", "secId" ]
},
"activityModuleTicketFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"ticketNumber" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
},
"subject" : {
"type" : [ "string", "null" ],
"maxLength" : 1000,
"minLength" : 0
},
"isArchived" : {
"type" : [ "boolean", "null" ]
},
"dueDate" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"channel" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"team" : {
"$ref" : "#/components/schemas/teamFields"
},
"closedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"secId" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"phone" : {
"type" : [ "string", "null" ],
"maxLength" : 120,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
},
"teamId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"contact" : {
"$ref" : "#/components/schemas/activityModuleContactFields"
},
"createdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"assignee" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"isSpam" : {
"type" : [ "boolean", "null" ]
},
"status" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
}
},
"required" : [ "assignee", "channel", "closedTime", "contact", "createdTime", "dueDate", "id", "isArchived", "isSpam", "phone", "secId", "status", "subject", "team", "teamId", "ticketNumber" ]
},
"searchCallResponseFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"modifiedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"statusType" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"customFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"subject" : {
"type" : [ "string", "null" ],
"maxLength" : 300,
"minLength" : 0
},
"completedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"departmentId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"creatorId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 65535,
"minLength" : 0
},
"ownerId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"duration" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
},
"isCommented" : {
"type" : [ "boolean", "null" ]
},
"contact" : {
"$ref" : "#/components/schemas/activityModuleContactFields"
},
"createdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"startTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"modifiedBy" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"department" : {
"$ref" : "#/components/schemas/departmentFields"
},
"direction" : {
"type" : [ "string", "null" ],
"enum" : [ "outbound", "inbound" ],
"maxLength" : 100,
"minLength" : 0
},
"cf" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"reminder" : {
"type" : [ "array", "null" ],
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false
},
"maxItems" : 3,
"uniqueItems" : false
},
"ticket" : {
"$ref" : "#/components/schemas/activityModuleTicketFields"
},
"contactId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"priority" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"callId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"activityTime" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"isSpam" : {
"type" : [ "boolean", "null" ]
},
"layoutId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"webUrl" : {
"type" : [ "string", "null" ],
"maxLength" : 300,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"assignee" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"activityType" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"ticketId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"status" : {
"type" : [ "string", "null" ],
"enum" : [ "Completed", "Scheduled", "Missed", "Canceled", "In Progress" ],
"maxLength" : 100,
"minLength" : 0
}
},
"required" : [ "activityTime", "activityType", "assignee", "callId", "cf", "completedTime", "contact", "contactId", "createdTime", "creatorId", "customFields", "department", "departmentId", "description", "direction", "duration", "id", "isCommented", "isSpam", "layoutId", "modifiedBy", "modifiedTime", "ownerId", "priority", "reminder", "startTime", "status", "statusType", "subject", "ticket", "ticketId", "webUrl" ]
},
"searchCallsData" : {
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/components/schemas/searchCallResponseFields"
}
},
"accountFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"owner" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"website" : {
"type" : [ "string", "null" ],
"maxLength" : 120,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[0-9a-zA-Z][-.\\w]*(:[0-9])*(/?)([a-zA-Z0-9\\-\\.\\?\\,|\\:\\'\\/\\+=&%\\$#_\\[\\]@!\\(\\)\\*;~]*)?$)|[*]"
},
"cf" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"accountName" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0
},
"phone" : {
"type" : [ "string", "null" ],
"maxLength" : 30,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
},
"webUrl" : {
"type" : [ "string", "null" ],
"maxLength" : 500,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"customFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"email" : {
"type" : [ "string", "null" ],
"maxLength" : 255,
"minLength" : 0,
"pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
}
},
"required" : [ "accountName", "cf", "customFields", "email", "id", "owner", "phone", "webUrl", "website" ]
},
"searchAccountResponseFields" : {
"additionalProperties" : false,
"allOf" : [ {
"$ref" : "#/components/schemas/accountFields"
}, {
"type" : [ "object", "null" ],
"properties" : {
"owner" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"country" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"modifiedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"code" : {
"type" : [ "string", "null" ],
"maxLength" : 30,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
},
"city" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 65535,
"minLength" : 0
},
"industry" : {
"type" : [ "string", "null" ],
"maxLength" : 120,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
},
"ownerId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"layoutId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"annualrevenue" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
},
"street" : {
"type" : [ "string", "null" ],
"maxLength" : 250,
"minLength" : 0
},
"createdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"state" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"fax" : {
"type" : [ "string", "null" ],
"maxLength" : 30,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
}
},
"required" : [ "annualrevenue", "annualrevenue", "city", "code", "country", "createdTime", "description", "fax", "industry", "layoutId", "modifiedTime", "owner", "ownerId", "state", "street" ],
"additionalProperties" : false
} ]
},
"searchAccountsData" : {
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/components/schemas/searchAccountResponseFields"
}
},
"contactFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"owner" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"lastName" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0
},
"secondaryEmail" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
},
"cf" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"customFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"mobile" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
},
"ownerId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"type" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"firstName" : {
"type" : [ "string", "null" ],
"maxLength" : 40,
"minLength" : 0
},
"accountId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"photoURL" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"phone" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 0,
"pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
},
"webUrl" : {
"type" : [ "string", "null" ],
"maxLength" : 500,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"zohoCRMContact" : {
"type" : [ "object", "null" ],
"additionalProperties" : false
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"customerHappiness" : {
"$ref" : "./Contact.json#/components/schemas/customerHappiness"
},
"email" : {
"type" : [ "string", "null" ],
"maxLength" : 255,
"minLength" : 0,
"pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
},
"account" : {
"$ref" : "#/components/schemas/subModuleAccountFields"
}
},
"required" : [ "account", "accountId", "cf", "customFields", "customerHappiness", "email", "firstName", "id", "lastName", "mobile", "owner", "ownerId", "phone", "photoURL", "secondaryEmail", "type", "webUrl", "zohoCRMContact" ]
},
"searchContactResponseFields" : {
"additionalProperties" : false,
"allOf" : [ {
"$ref" : "#/components/schemas/contactFields"
}, {
"type" : [ "object", "null" ],
"properties" : {
"zip" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
},
"owner" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"country" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"modifiedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"city" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"facebook" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 65535,
"minLength" : 0
},
"title" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"layoutId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"twitter" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"street" : {
"type" : [ "string", "null" ],
"maxLength" : 250,
"minLength" : 0
},
"createdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"isEndUser" : {
"type" : [ "boolean", "null" ]
},
"state" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
}
},
"required" : [ "city", "country", "createdTime", "description", "facebook", "isEndUser", "layoutId", "modifiedTime", "owner", "state", "street", "title", "twitter", "zip" ],
"additionalProperties" : false
} ]
},
"searchContactsData" : {
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/components/schemas/searchContactResponseFields"
}
},
"searchEventResponseFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"modifiedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"statusType" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"customFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"subject" : {
"type" : [ "string", "null" ],
"maxLength" : 300,
"minLength" : 0
},
"completedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"departmentId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"creatorId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 65535,
"minLength" : 0
},
"ownerId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"duration" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
},
"isCommented" : {
"type" : [ "boolean", "null" ]
},
"contact" : {
"$ref" : "#/components/schemas/activityModuleContactFields"
},
"createdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"startTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"modifiedBy" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"department" : {
"$ref" : "#/components/schemas/departmentFields"
},
"cf" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"reminder" : {
"type" : [ "array", "null" ],
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false
},
"maxItems" : 3,
"uniqueItems" : false
},
"ticket" : {
"$ref" : "#/components/schemas/activityModuleTicketFields"
},
"contactId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"priority" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"activityTime" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"layoutId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"isSpam" : {
"type" : [ "boolean", "null" ]
},
"webUrl" : {
"type" : [ "string", "null" ],
"maxLength" : 300,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"assignee" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"category" : {
"type" : [ "string", "null" ],
"maxLength" : 120,
"minLength" : 0
},
"activityType" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"ticketId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"status" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
}
},
"required" : [ "activityTime", "activityType", "assignee", "category", "cf", "completedTime", "contact", "contactId", "createdTime", "creatorId", "customFields", "department", "departmentId", "description", "duration", "id", "isCommented", "isSpam", "layoutId", "modifiedBy", "modifiedTime", "ownerId", "priority", "reminder", "startTime", "status", "statusType", "subject", "ticket", "ticketId", "webUrl" ]
},
"searchEventResponseFieldsWithModule" : {
"additionalProperties" : false,
"allOf" : [ {
"$ref" : "#/components/schemas/searchEventResponseFields"
}, {
"type" : [ "object", "null" ],
"properties" : {
"module" : {
"type" : [ "string", "null" ],
"enum" : [ "accounts", "contacts", "tickets", "Tasks", "Calls", "Events" ]
}
},
"required" : [ "module" ],
"additionalProperties" : false
} ]
},
"searchCallResponseFieldsWithModule" : {
"additionalProperties" : false,
"allOf" : [ {
"$ref" : "#/components/schemas/searchCallResponseFields"
}, {
"type" : [ "object", "null" ],
"properties" : {
"module" : {
"type" : [ "string", "null" ],
"enum" : [ "accounts", "contacts", "tickets", "Tasks", "Calls", "Events" ]
}
},
"required" : [ "module" ],
"additionalProperties" : false
} ]
},
"searchTaskResponseFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"modifiedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"statusType" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"customFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"subject" : {
"type" : [ "string", "null" ],
"maxLength" : 300,
"minLength" : 0
},
"completedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"dueDate" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"departmentId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"creatorId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 65535,
"minLength" : 0
},
"ownerId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"isCommented" : {
"type" : [ "boolean", "null" ]
},
"contact" : {
"$ref" : "#/components/schemas/activityModuleContactFields"
},
"createdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"modifiedBy" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"department" : {
"$ref" : "#/components/schemas/departmentFields"
},
"cf" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"ticket" : {
"$ref" : "#/components/schemas/activityModuleTicketFields"
},
"reminder" : {
"type" : [ "array", "null" ],
"items" : {
"type" : [ "object", "null" ],
"additionalProperties" : false
},
"maxItems" : 3,
"uniqueItems" : false
},
"contactId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"priority" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"activityTime" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"layoutId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"isSpam" : {
"type" : [ "boolean", "null" ]
},
"webUrl" : {
"type" : [ "string", "null" ],
"maxLength" : 300,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"assignee" : {
"$ref" : "#/components/schemas/assigneeFields"
},
"category" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"activityType" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"ticketId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"status" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
}
},
"required" : [ "activityTime", "activityType", "assignee", "category", "cf", "completedTime", "contact", "contactId", "createdTime", "creatorId", "customFields", "department", "departmentId", "description", "dueDate", "id", "isCommented", "isSpam", "layoutId", "modifiedBy", "modifiedTime", "ownerId", "priority", "reminder", "status", "statusType", "subject", "ticket", "ticketId", "webUrl" ]
},
"searchTaskResponseFieldsWithModule" : {
"additionalProperties" : false,
"allOf" : [ {
"$ref" : "#/components/schemas/searchTaskResponseFields"
}, {
"type" : [ "object", "null" ],
"properties" : {
"module" : {
"type" : [ "string", "null" ],
"enum" : [ "accounts", "contacts", "tickets", "Tasks", "Calls", "Events" ]
}
},
"required" : [ "module" ],
"additionalProperties" : false
} ]
},
"activitiesSearchData" : {
"type" : [ "array", "null" ],
"items" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/searchEventResponseFieldsWithModule"
}, {
"$ref" : "#/components/schemas/searchCallResponseFieldsWithModule"
}, {
"$ref" : "#/components/schemas/searchTaskResponseFieldsWithModule"
} ]
}
},
"categoryFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"name" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "id", "name" ]
},
"author" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"photoURL" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
},
"name" : {
"type" : [ "string", "null" ],
"maxLength" : 50,
"minLength" : 0
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "id", "name", "photoURL" ]
},
"searchSolutionResponseFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"modifiedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"creatorId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"modifierId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"dislikeCount" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"likeCount" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"title" : {
"type" : [ "string", "null" ],
"maxLength" : 500,
"minLength" : 0
},
"createdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"viewCount" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"summary" : {
"type" : [ "string", "null" ],
"maxLength" : 65553,
"minLength" : 0
},
"latestVersionStatus" : {
"type" : [ "string", "null" ],
"enum" : [ "Published", "Unpublished", "Draft", "Review", "Expired", "Auto-translate Pending", "Auto-translate Failed" ],
"maxLength" : 100,
"minLength" : 0
},
"author" : {
"$ref" : "#/components/schemas/author"
},
"permission" : {
"type" : [ "string", "null" ],
"enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS" ],
"maxLength" : 100,
"minLength" : 0
},
"authorId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"usageCount" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"rootCategoryId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"latestVersion" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"webUrl" : {
"type" : [ "string", "null" ],
"maxLength" : 500,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"portalUrl" : {
"type" : [ "string", "null" ],
"maxLength" : 500,
"minLength" : 0,
"pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)"
},
"feedbackCount" : {
"type" : [ "string", "integer", "null" ],
"format" : "int32",
"pattern" : "([0-9]+)"
},
"latestPublishedVersion" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0
},
"permalink" : {
"type" : [ "string", "null" ],
"maxLength" : 500,
"minLength" : 0,
"pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*"
},
"category" : {
"$ref" : "#/components/schemas/categoryFields"
},
"categoryId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"status" : {
"type" : [ "string", "null" ],
"enum" : [ "Published", "Unpublished", "Draft", "Review", "Expired", "Auto-translate Pending", "Auto-translate Failed" ],
"maxLength" : 100,
"minLength" : 0
}
},
"required" : [ "author", "authorId", "category", "categoryId", "createdTime", "creatorId", "dislikeCount", "feedbackCount", "id", "latestPublishedVersion", "latestVersion", "latestVersionStatus", "likeCount", "modifiedTime", "modifierId", "permalink", "permission", "portalUrl", "rootCategoryId", "status", "summary", "title", "usageCount", "viewCount", "webUrl" ]
},
"searchSolutionsData" : {
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/components/schemas/searchSolutionResponseFields"
}
},
"searchProductResponseFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"unitPrice" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
},
"modifiedTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"cf" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"customFields" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"patternProperties" : {
"([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
}
}
},
"description" : {
"type" : [ "string", "null" ],
"maxLength" : 65535,
"minLength" : 0,
"pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
},
"departmentIds" : {
"type" : [ "array", "null" ],
"items" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"uniqueItems" : true
},
"ownerId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"layoutId" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"productName" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0
},
"manufacturer" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"productCategory" : {
"type" : [ "string", "null" ],
"x-dynamic-enum" : true
},
"productCode" : {
"type" : [ "string", "null" ],
"maxLength" : 200,
"minLength" : 0
},
"createdBy" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"createdTime" : {
"type" : [ "string", "null" ],
"maxLength" : 100,
"minLength" : 0,
"pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
},
"modifiedBy" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"id" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "cf", "createdBy", "createdTime", "customFields", "departmentIds", "description", "id", "layoutId", "manufacturer", "modifiedBy", "modifiedTime", "ownerId", "productCategory", "productCode", "productName", "unitPrice" ]
},
"searchProductsData" : {
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/components/schemas/searchProductResponseFields"
}
},
"searchEventsData" : {
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/components/schemas/searchEventResponseFields"
}
},
"searchTicketResponseFieldsWithModule" : {
"additionalProperties" : false,
"allOf" : [ {
"$ref" : "#/components/schemas/searchTicketResponseFields"
}, {
"type" : [ "object", "null" ],
"properties" : {
"module" : {
"type" : [ "string", "null" ],
"enum" : [ "accounts", "contacts", "tickets", "Tasks", "Calls", "Events" ]
}
},
"required" : [ "module" ],
"additionalProperties" : false
} ]
},
"searchContactResponseFieldsWithModule" : {
"additionalProperties" : false,
"allOf" : [ {
"$ref" : "#/components/schemas/searchContactResponseFields"
}, {
"type" : [ "object", "null" ],
"properties" : {
"module" : {
"type" : [ "string", "null" ],
"enum" : [ "accounts", "contacts", "tickets", "Tasks", "Calls", "Events" ]
}
},
"required" : [ "module" ],
"additionalProperties" : false
} ]
},
"searchAccountResponseFieldsWithModule" : {
"additionalProperties" : false,
"allOf" : [ {
"$ref" : "#/components/schemas/searchAccountResponseFields"
}, {
"type" : [ "object", "null" ],
"properties" : {
"module" : {
"type" : [ "string", "null" ],
"enum" : [ "accounts", "contacts", "tickets", "Tasks", "Calls", "Events" ]
}
},
"required" : [ "module" ],
"additionalProperties" : false
} ]
},
"doSearchData" : {
"type" : [ "array", "null" ],
"items" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/searchTicketResponseFieldsWithModule"
}, {
"$ref" : "#/components/schemas/searchContactResponseFieldsWithModule"
}, {
"$ref" : "#/components/schemas/searchAccountResponseFieldsWithModule"
}, {
"$ref" : "#/components/schemas/searchTaskResponseFieldsWithModule"
} ]
}
},
"doSearchCount" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"tickets" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"calls" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"solutions" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"accounts" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"community" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"contacts" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"tasks" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"events" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
},
"products" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "tickets" ]
},
"searchTasksData" : {
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/components/schemas/searchTaskResponseFields"
}
}
},
"responses" : {
"searchTicketsResponse" : {
"description" : "searchTicketsResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchTicketsData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"modifiedTime" : "2016-06-21T13:16:14.000Z",
"ticketNumber" : "101",
"subCategory" : "Sub General",
"statusType" : "Open",
"subject" : "Hi. There is a sudden delay in the processing of the orders. Check this with high priority",
"dueDate" : "2016-06-21T16:16:16.000Z",
"departmentId" : "1892000000006907",
"isRead" : false,
"channel" : "FORUMS",
"onholdTime" : null,
"description" : "Hi. There is a sudden delay in the processing of the orders. Check this with high priority",
"resolution" : null,
"sharedDepartments" : [ {
"name" : "Sample Department Name",
"id" : "1892000000006909",
"type" : [ "READ_WRITE" ]
}, {
"name" : "Sample Department Name",
"id" : "1892000000006911",
"type" : [ "READ_ONLY" ]
} ],
"closedTime" : null,
"isOverDue" : false,
"contact" : {
"lastName" : "Carol",
"firstName" : "Lucas",
"phone" : "+1 5550100123",
"mobile" : "+1 5550100123",
"id" : "1892000000042032",
"type" : null,
"email" : "carol@zylker.com",
"account" : {
"website" : "www.desk.com",
"accountName" : "desk Account",
"id" : "1892000000975382"
}
},
"createdTime" : "2013-11-04T11:21:07.000Z",
"modifiedBy" : "52338000000043001",
"id" : "1892000000042034",
"department" : {
"name" : "dasdasdasd",
"id" : "1892000000006907"
},
"email" : "carol@zylker.com",
"customerResponseTime" : "2013-11-04T11:21:07.912Z",
"product" : null,
"cf" : {
"cf_permanentaddress" : null,
"cf_dateofpurchase" : null,
"cf_phone" : null,
"cf_numberofitems" : null,
"cf_url" : null,
"cf_secondaryemail" : null,
"cf_severitypercentage" : "0.0",
"cf_modelname" : "F3 2017"
},
"productId" : null,
"contactId" : "1892000000042032",
"threadCount" : "121",
"lastThread" : {
"channel" : "FEEDBACK",
"isDraft" : false,
"isForward" : false,
"direction" : "in"
},
"team" : {
"name" : "kjsdfjks",
"id" : "8920000000069071",
"logoUrl" : "https://desk.zoho.com/api/v1/teams/8920000000069071/logo?orgId=123456"
},
"priority" : "High",
"classification" : null,
"assigneeId" : "1892000000056007",
"commentCount" : "1",
"phone" : "+1 5550100123",
"createdBy" : "52338000000043001",
"webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
"teamId" : "8920000000069071",
"isEscalated" : false,
"isSpam" : false,
"assignee" : {
"firstName" : "dasca",
"lastName" : "vins",
"photoURL" : "https://desk.zoho.com/api/v1/agents/1892000000056007/photo?orgId=123456",
"emailId" : "jack@zylker.com",
"id" : "1892000000056007",
"zuid" : "640954748"
},
"category" : "general",
"status" : "Open"
}, {
"modifiedTime" : "2016-06-21T13:16:14.000Z",
"ticketNumber" : "101",
"subCategory" : "Sub General",
"statusType" : "Open",
"subject" : "Hi. There is a sudden delay in the processing of the orders. Check this with high priority",
"dueDate" : "2016-06-21T16:16:16.000Z",
"departmentId" : "1892000000006907",
"isRead" : false,
"channel" : "FORUMS",
"onholdTime" : null,
"description" : "Hi. There is a sudden delay in the processing of the orders. Check this with high priority",
"resolution" : null,
"sharedDepartments" : [ {
"name" : "Sample Department Name",
"id" : "1892000000006909",
"type" : "READ_WRITE"
}, {
"name" : "Sample Department Name",
"id" : "1892000000006911",
"type" : "READ_ONLY"
} ],
"closedTime" : null,
"isOverDue" : false,
"contact" : {
"lastName" : "Carol",
"firstName" : "Lucas",
"phone" : "+1 5550100123",
"mobile" : "+1 5550100123",
"id" : "1892000000042032",
"type" : null,
"email" : "carol@zylker.com",
"account" : {
"website" : "www.desk.com",
"accountName" : "desk Account",
"id" : "1892000000975382"
}
},
"createdTime" : "2013-11-04T11:21:07.000Z",
"modifiedBy" : "52338000000043001",
"id" : "1892000000042034",
"department" : {
"name" : "dasdasdasd",
"id" : "1892000000006907"
},
"email" : "carol@zylker.com",
"customerResponseTime" : "2013-11-04T11:21:07.912Z",
"product" : null,
"cf" : {
"cf_permanentaddress" : null,
"cf_dateofpurchase" : null,
"cf_phone" : null,
"cf_numberofitems" : null,
"cf_url" : null,
"cf_secondaryemail" : null,
"cf_severitypercentage" : "0.0",
"cf_modelname" : "F3 2017"
},
"productId" : null,
"contactId" : "1892000000042032",
"threadCount" : "121",
"lastThread" : {
"channel" : "FEEDBACK",
"isDraft" : false,
"isForward" : false,
"direction" : "in"
},
"team" : {
"name" : "kjsdfjks",
"id" : "8920000000069071",
"logoUrl" : "https://desk.zoho.com/api/v1/teams/8920000000069071/logo?orgId=123456"
},
"priority" : "High",
"classification" : null,
"assigneeId" : "1892000000056007",
"commentCount" : "1",
"phone" : "+1 5550100123",
"createdBy" : "52338000000043001",
"webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
"teamId" : "8920000000069071",
"isEscalated" : false,
"isSpam" : false,
"assignee" : {
"firstName" : "dasca",
"lastName" : "vins",
"photoURL" : "https://desk.zoho.com/api/v1/agents/1892000000056007/photo?orgId=123456",
"emailId" : "jack@zylker.com",
"id" : "1892000000056007",
"zuid" : "640954748"
},
"category" : "general",
"status" : "Open"
} ],
"count" : 1
}
}
}
}
}
},
"searchRecordsResponse" : {
"description" : "searchRecordsResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "./Records.json#/components/schemas/listRecordResponseWithAdditionalData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"layout" : {
"id" : "1000003000004",
"layoutName" : "Standard - Department1"
},
"owner" : {
"firstName" : "",
"lastName" : "Kyle",
"photoURL" : "https://desk.zoho.com/api/v1/agents/4000000000329/photo?orgId=123456",
"id" : "4000000000329"
},
"modifiedTime" : "2024-04-22T14:09:41.000Z",
"cf" : {
"cf_doctor_description" : "Doctor 1 description change"
},
"createdBy" : {
"firstName" : "",
"lastName" : "Kyle",
"photoURL" : "https://desk.zoho.com/api/v1/agents/4000000000329/photo?orgId=123456",
"id" : "4000000000329"
},
"name" : "Doctor 1",
"createdTime" : "2024-04-22T13:55:53.000Z",
"modifiedBy" : {
"firstName" : "",
"lastName" : "Kyle",
"photoURL" : "https://desk.zoho.com/api/v1/agents/4000000000329/photo?orgId=123456",
"id" : "4000000000329"
},
"isPresence" : true,
"id" : "1000003019049",
"department" : {
"name" : "Department1",
"id" : "1000000025632"
}
}
}
}
}
}
},
"searchCallsResponse" : {
"description" : "searchCallsResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchCallsData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"modifiedTime" : "2016-07-26T17:32:11.000Z",
"cf" : {
"cf_permanentaddress" : "Menlo Park, California"
},
"ticket" : {
"ticketNumber" : "101",
"contact" : {
"firstName" : null,
"lastName" : "Lawrence",
"phoneNumber" : "+1 5550100123",
"id" : "3000000008749"
},
"id" : "3000000008753"
},
"subject" : "New Call",
"completedTime" : "2016-07-26T17:32:11.000Z",
"departmentId" : "3000000007043",
"creatorId" : "3000000008692",
"description" : null,
"ownerId" : null,
"priority" : "Normal",
"duration" : "300",
"createdTime" : "2016-07-26T17:32:11.000Z",
"startTime" : "2016-07-25T16:52:11.000Z",
"id" : "3000000018001",
"assignee" : {
"firstName" : "",
"lastName" : "raja",
"photoURL" : null,
"emailId" : "carol@zylker.com",
"id" : "36385000000120033",
"zuid" : "55499215"
},
"ticketId" : "3000000008753",
"direction" : "inbound",
"status" : "completed"
} ],
"count" : 1
}
}
}
}
}
},
"searchAccountsResponse" : {
"description" : "searchAccountsResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchAccountsData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"owner" : {
"firstName" : "Twin",
"lastName" : "john",
"photoURL" : "https://desk.zoho.com/api/v1/agents/52338000000691001/photo?t=user&ID=10657727",
"emailId" : "jade@zylker.com",
"id" : "3263000000057001",
"zuid" : "10657727"
},
"country" : "USA",
"modifiedTime" : "2015-03-02T14:49:18.000Z",
"website" : "www.zylker.com",
"code" : "3211",
"cf" : {
"cf_contactcount" : "1"
},
"accountName" : "Zylker",
"city" : null,
"description" : null,
"industry" : "Automation",
"ownerId" : "3263000000057001",
"phone" : "+1 5550100123",
"street" : null,
"annualrevenue" : null,
"webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
"createdTime" : "2015-02-16T16:57:44.000Z",
"state" : null,
"id" : "3263000000074571",
"fax" : "+1 5550100123",
"email" : "support@zylker.com"
} ],
"count" : 1
}
}
}
}
}
},
"searchContactsResponse" : {
"description" : "searchContactsResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchContactsData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"lastName" : "Lawrence",
"modifiedTime" : "2016-05-04T09:57:17.000Z",
"country" : null,
"secondaryEmail" : null,
"city" : null,
"description" : null,
"ownerId" : "1892000000042001",
"type" : null,
"title" : null,
"photoURL" : "https://desk.zoho.com/api/v1/contacts/1892000000042032/photo",
"twitter" : null,
"street" : null,
"createdTime" : "2013-11-04T11:21:07.000Z",
"isEndUser" : "false",
"zohoCRMContact" : {
"id" : "5000000014010",
"type" : [ "contacts_leads" ]
},
"customerHappiness" : {
"badPercentage" : "22",
"okPercentage" : "31",
"goodPercentage" : "47"
},
"state" : null,
"id" : "1892000000042032",
"email" : "lawrence@zylker.com",
"zip" : null,
"owner" : {
"firstName" : "Twin",
"lastName" : "john",
"photoURL" : null,
"emailId" : "lawrence@zylker.com",
"id" : "1892000000042001",
"zuid" : "14345345"
},
"cf" : {
"cf_permanentaddress" : "Menlo Park, California",
"cf_lastcontactedon" : null
},
"facebook" : null,
"mobile" : null,
"accountId" : "1892000000975382",
"firstName" : "Jennifer",
"phone" : "+1 5550100123",
"webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
"account" : {
"website" : null,
"accountName" : "Zylker",
"id" : "1892000000975382"
}
}, {
"lastName" : "Lawrence",
"modifiedTime" : "2016-05-04T09:57:17.000Z",
"country" : null,
"secondaryEmail" : null,
"city" : null,
"description" : null,
"ownerId" : "1892000000042001",
"type" : null,
"title" : null,
"photoURL" : "https://desk.zoho.com/api/v1/contacts/1892000000042032/photo",
"twitter" : null,
"street" : null,
"createdTime" : "2013-11-04T11:21:07.000Z",
"isEndUser" : "false",
"zohoCRMContact" : {
"id" : "5000000014010",
"type" : "contacts_leads"
},
"customerHappiness" : {
"badPercentage" : "22",
"okPercentage" : "31",
"goodPercentage" : "47"
},
"state" : null,
"id" : "1892000000042032",
"email" : "lawrence@zylker.com",
"zip" : null,
"owner" : {
"firstName" : "Twin",
"lastName" : "john",
"photoURL" : null,
"emailId" : "lawrence@zylker.com",
"id" : "1892000000042001",
"zuid" : "14345345"
},
"cf" : {
"cf_permanentaddress" : "Menlo Park, California",
"cf_lastcontactedon" : null
},
"facebook" : null,
"mobile" : null,
"accountId" : "1892000000975382",
"firstName" : "Jennifer",
"phone" : "+1 5550100123",
"webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
"account" : {
"website" : null,
"accountName" : "Zylker",
"id" : "1892000000975382"
}
} ],
"count" : 1
}
}
}
}
}
},
"activitiesSearchResponse" : {
"description" : "activitiesSearchResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/activitiesSearchData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"modifiedTime" : "2016-09-13T12:14:41.000Z",
"ticket" : null,
"customFields" : { },
"subject" : "Bug Fix #121",
"completedTime" : null,
"module" : "task",
"departmentId" : "3000000007043",
"dueDate" : "2016-09-19T12:27:26.000Z",
"creatorId" : "3000000008692",
"description" : null,
"ownerId" : "3000000054002",
"priority" : "High",
"isCommented" : false,
"createdTime" : "2016-08-14T08:27:26.000Z",
"assignee" : {
"firstName" : "",
"lastName" : "jade",
"photoURL" : "https://contacts.zoho.com/file?t=user&ID=10657727",
"emailId" : "jade@zylker.com",
"id" : "5000000009116",
"zuid" : "10657727"
},
"id" : "3000000054004",
"department" : {
"name" : "Testing",
"id" : "5000000007235"
},
"category" : null,
"ticketId" : null,
"status" : "Not Started"
} ],
"count" : 1
}
}
}
}
}
},
"searchSolutionsResponse" : {
"description" : "searchSolutionsResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"oneOf" : [ {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchSolutionsData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
}, {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "./ArticleTranslation.json#/components/schemas/articleTranslationListView"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
}, {
"type" : [ "null", "object" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchSolutionsData"
},
"count" : {
"type" : [ "string", "null", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
}, {
"type" : [ "null", "object" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "./ArticleTranslation.json#/components/schemas/articleTranslationListView"
},
"count" : {
"type" : [ "string", "null", "integer" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
} ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"summary" : "Help articles are vital resources in user education. They are the first building blocks of an effective self-service setup.",
"modifiedTime" : "2018-07-16T06:48:08.000Z",
"latestVersionStatus" : "Published",
"author" : {
"photoURL" : null,
"name" : "HIll",
"id" : "5000000015935"
},
"creatorId" : "4000000012931",
"modifierId" : "4000000012931",
"dislikeCount" : "1",
"permission" : "AGENTS",
"likeCount" : "2",
"title" : "Importance of a Knowledge Base",
"authorId" : "4000000012931",
"usageCount" : "3",
"latestVersion" : "1.0",
"webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/22372000000281023",
"portalUrl" : "https://desk.zoho.com/portal/zylker/kb/articles/importance-of-knowledge-base",
"feedbackCount" : "1",
"createdTime" : "2018-07-16T06:48:08.000Z",
"latestPublishedVersion" : "1.0",
"viewCount" : "3",
"id" : "22372000000281023",
"permalink" : "importance-of-a-knowledge-base",
"category" : {
"name" : "General",
"id" : "5000000017008"
},
"categoryId" : "4000000013240",
"status" : "Published"
} ],
"count" : 379
}
}
}
}
}
},
"searchProductsResponse" : {
"description" : "searchProductsResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchProductsData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"modifiedTime" : "2017-11-02T10:31:35.000Z",
"productCode" : "Search2",
"cf" : {
"cf_productTagName" : "secondary engine"
},
"createdBy" : "5000000009116",
"description" : null,
"createdTime" : "2017-11-02T10:31:35.000Z",
"modifiedBy" : "5000000009116",
"departmentIds" : [ "5000000007235" ],
"id" : "5000000009882",
"productName" : "Search2"
} ],
"count" : 1
}
}
}
}
}
},
"searchEventsResponse" : {
"description" : "searchEventsResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchEventsData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"modifiedTime" : "2016-07-26T17:32:11.000Z",
"ticket" : {
"ticketNumber" : "101",
"contact" : {
"firstName" : null,
"lastName" : "Lawrence",
"id" : "3000000008749"
},
"id" : "3000000008753"
},
"customFields" : { },
"subject" : "New Event",
"completedTime" : "2016-07-26T17:32:11.000Z",
"departmentId" : "3000000007043",
"creatorId" : "3000000008692",
"description" : null,
"ownerId" : null,
"priority" : "Normal",
"duration" : "30",
"createdTime" : "2016-07-26T16:32:11.000Z",
"startTime" : "2016-07-26T17:02:11.000Z",
"id" : "3000000018001",
"assignee" : {
"firstName" : "",
"lastName" : "raja",
"photoURL" : null,
"emailId" : "carol@zylker.com",
"id" : "36385000000120033",
"zuid" : "55499215"
},
"category" : "Meeting",
"ticketId" : "3000000008753",
"status" : "completed"
} ],
"count" : 1
}
}
}
}
}
},
"doSearchResponse" : {
"description" : "doSearchResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"anyOf" : [ {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/doSearchData"
},
"count" : {
"$ref" : "#/components/schemas/doSearchCount"
}
},
"required" : [ "count", "data" ]
}, {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchTicketsData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
} ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"subject" : "Zylker ticket",
"departmentId" : "4000000007043",
"dueDate" : null,
"channel" : "Phone",
"onholdTime" : null,
"sharedDepartments" : [ ],
"closedTime" : null,
"number" : "104",
"contact" : {
"phone" : null,
"mobile" : "+1 5550100123",
"name" : "Stephen",
"id" : "4000000013012",
"type" : null,
"email" : null,
"account" : {
"website" : null,
"name" : "Zylker Accounts",
"id" : "4000000008850"
}
},
"createdTime" : "2016-06-27T07:22:52.000Z",
"id" : "4000000016009",
"department" : {
"name" : "Testing",
"id" : "4000000007043"
},
"email" : null,
"customerResponseTime" : "2016-06-27T07:22:52.117Z",
"cf" : {
"cf_featureRequest" : false,
"cf_region" : "Asia"
},
"productId" : "4000000013043",
"contactId" : "4000000013012",
"module" : "tickets",
"threadCount" : "0",
"team" : {
"name" : "TestingTeam",
"id" : "4000000007235",
"logoUrl" : "https://desk.zoho.com/api/v1/teams/4000000007235/logo?orgId=123456"
},
"priority" : null,
"assigneeId" : "4000000008692",
"commentCount" : "0",
"phone" : null,
"assignee" : {
"firstName" : "",
"lastName" : "jade",
"photoURL" : "https://contacts.zoho.com/file?t=user&ID=10657727",
"emailId" : "jade@zylker.com",
"id" : "4000000008692",
"zuid" : "10657727"
},
"status" : "Open"
}, {
"cf" : {
"cf_followUpDate" : "2016-07-07T19:30:00.000Z",
"cf_severity" : "High"
},
"ticket" : null,
"subject" : "Wifi adapter not working in zylker",
"completedTime" : null,
"module" : "tasks",
"dueDate" : "2016-06-27T19:30:00.000Z",
"description" : null,
"ownerId" : "4000000008692",
"priority" : "High",
"isCommented" : false,
"createdBy" : "4000000008692",
"contact" : null,
"createdTime" : "2016-06-27T06:39:48.000Z",
"id" : "4000000013065",
"assignee" : {
"firstName" : "",
"lastName" : "jade",
"photoURL" : "https://contacts.zoho.com/file?t=user&ID=10657727",
"emailId" : "jade@zylker.com",
"id" : "5000000009116",
"zuid" : "10657727"
},
"category" : null,
"department" : {
"name" : "Testing",
"id" : "5000000007235"
},
"ticketId" : null,
"status" : "Not Started"
}, {
"website" : null,
"phone" : null,
"accountName" : "Zylker India",
"customFields" : {
"city" : "Delhi",
"state" : "India"
},
"module" : "accounts",
"id" : "4000000013027",
"email" : null
}, {
"lastName" : "Stephen",
"accountId" : "4000000008850",
"firstName" : "Henry",
"photoURL" : null,
"phone" : null,
"customFields" : {
"customerSince" : "2011",
"editionUsed" : "Professional"
},
"module" : "contacts",
"fullName" : "Henry Stephen",
"id" : "4000000013012",
"ownerId" : "4000000008692",
"email" : null,
"account" : {
"website" : null,
"name" : "Zylker India",
"id" : "4000000008850"
}
} ],
"count" : {
"tickets" : 1,
"accounts" : 1,
"tasks" : 1,
"contacts" : 1
}
}
}
}
}
}
},
"searchTasksResponse" : {
"description" : "searchTasksResponse template definitions",
"content" : {
"application/json" : {
"schema" : {
"type" : [ "object", "null" ],
"additionalProperties" : false,
"properties" : {
"data" : {
"$ref" : "#/components/schemas/searchTasksData"
},
"count" : {
"type" : [ "string", "integer", "null" ],
"format" : "int64",
"pattern" : "([0-9]+)"
}
},
"required" : [ "count", "data" ]
},
"examples" : {
"Valid responses Definitions" : {
"value" : {
"data" : [ {
"modifiedTime" : "2016-09-13T12:14:41.000Z",
"cf" : {
"cf_permanentaddress" : "Menlo Park, California"
},
"ticket" : null,
"subject" : "Bug Fix #121",
"completedTime" : null,
"departmentId" : "3000000007043",
"dueDate" : "2016-09-19T12:27:26.000Z",
"creatorId" : "3000000008692",
"description" : null,
"ownerId" : "3000000054002",
"priority" : "High",
"isCommented" : false,
"createdTime" : "2016-08-14T08:27:26.000Z",
"assignee" : {
"firstName" : "",
"lastName" : "jade",
"photoURL" : "https://contacts.zoho.com/file?t=user&ID=10657727",
"emailId" : "jade@zylker.com",
"id" : "5000000009116",
"zuid" : "10657727"
},
"id" : "3000000054004",
"department" : {
"name" : "Testing",
"id" : "5000000007235"
},
"category" : null,
"ticketId" : null,
"status" : "Not Started"
} ],
"count" : 1
}
}
}
}
}
}
},
"securitySchemes" : {
"cookie-auth" : {
"$ref" : "./Common.json#/components/securitySchemes/cookie-auth"
},
"org-oauth" : {
"$ref" : "./Common.json#/components/securitySchemes/org-oauth"
},
"iam-oauth2-schema" : {
"$ref" : "./Common.json#/components/securitySchemes/iam-oauth2-schema"
},
"deprecated-iam-oauth2-schema" : {
"$ref" : "./Common.json#/components/securitySchemes/deprecated-iam-oauth2-schema"
}
}
},
"x-entity" : "Search"
}