Endpoints in the simplified REST API
The endpoints in the BMC Helix ITSM simplified REST API are categorized by resource.
Available resources
Tip
To see example parameters for any of the following endpoints, click Try it out. Retain the example values for the parameters, or replace them with any valid value. Then click Execute to see the Curl command, request URL, and the response body for the request.
{
"swagger" : "2.0",
"info" : {
"description" : "",
"version" : "",
"title" : "",
"termsOfService" : "",
"contact" : {
"name" : "",
"url" : "",
"email" : ""
}
},
"host" : "",
"basePath" : "",
"tags" : [ {
"name" : "Attachment resource"
}, {
"name" : "Change resource"
}, {
"name" : "Foundation resource"
}, {
"name" : "Incident resource"
}, {
"name" : "Meta Data Operations resource"
}, {
"name" : "Person resource"
}, {
"name" : "Problem resource"
}, {
"name" : "Ticket Search resource."
}, {
"name" : "Validate API Doc resource."
}, {
"name" : "WorkNote Resource"
} ],
"paths" : {
"/attachment/download/{dataSource}/{attachmentFieldId}/{dataSourceId}" : {
"get" : {
"tags" : [ "Attachment resource" ],
"summary" : "Download Attachment",
"description" : "Download attachment from a ticket with the data provided",
"operationId" : "getAttachmentFile",
"consumes" : [ "application/json" ],
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "dataSource",
"in" : "path",
"description" : "Name of form from where attachment needs to be downloaded",
"required" : true,
"type" : "string",
"x-example" : "HPD:WorkLog"
}, {
"name" : "attachmentFieldId",
"in" : "path",
"description" : "Field ID of the attachement field",
"required" : true,
"type" : "string",
"x-example" : "1000000351"
}, {
"name" : "dataSourceId",
"in" : "path",
"description" : "Unique record Id",
"required" : true,
"type" : "string",
"x-example" : "AGGADGGXJ6E3GAQX5FEYQX5FEY55OK"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval"
},
"404" : {
"description" : "NOT FOUND: No attachment available for specified details."
}
}
}
},
"/metadata/{type}" : {
"get" : {
"tags" : [ "Meta Data Operations resource" ],
"summary" : "Search Metadata of given type",
"description" : "",
"operationId" : "getMetadata",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "type",
"in" : "path",
"description" : "Type for which metadata is to be returned.",
"required" : true,
"type" : "string",
"x-example" : "incident/change/problem"
}, {
"name" : "includeRequiredFields",
"in" : "query",
"description" : "Y/N value to include Required Fields information",
"required" : false,
"type" : "string",
"default" : "N",
"x-example" : "Y/N"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/TicketMetaData"
}
}
}
}
},
"/v2/api/schemaReport" : {
"get" : {
"tags" : [ "Validate API Doc resource." ],
"summary" : "Reporting Doc schema details defined in IS for REST APIs",
"description" : "",
"operationId" : "getSchemaReport",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "docname",
"in" : "query",
"description" : "document schema for which report needs to be generated",
"required" : false,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/api/validate" : {
"get" : {
"tags" : [ "Validate API Doc resource." ],
"summary" : "Validate Doc schema defined in IS for REST APIs",
"description" : "",
"operationId" : "validateApis",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "docname",
"in" : "query",
"description" : "document schema name to be validated",
"required" : false,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/change" : {
"post" : {
"tags" : [ "Change resource" ],
"summary" : "Creates the specified change ticket.",
"description" : "",
"operationId" : "createChange",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "Change",
"description" : "Change object with fields which needs to be created",
"required" : true,
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/change/search" : {
"post" : {
"tags" : [ "Change resource" ],
"summary" : "Get change ticket details based on passed query filter criteria",
"description" : "",
"operationId" : "getChangeDetails",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "SearchCriteria",
"description" : "Search Criteria for search",
"required" : false,
"schema" : {
"$ref" : "#/definitions/SearchCriteria"
}
}, {
"name" : "filter",
"in" : "query",
"description" : "Filter your search based on Assigned Groups and so on.",
"required" : false,
"type" : "string",
"x-example" : "My Group Need Attention Tickets"
}, {
"name" : "optimize",
"in" : "query",
"description" : "search result will be optimized to return only ids for subentities like person,customer,attachments for performance improvement",
"required" : false,
"type" : "string",
"x-example" : "Y/N"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/change/{id}" : {
"get" : {
"tags" : [ "Change resource" ],
"summary" : "Get change details based on Change Id",
"description" : "",
"operationId" : "getChangeById",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "ID of the change ticket",
"required" : true,
"type" : "string",
"x-example" : "CRQ000000000001"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Change resource" ],
"summary" : "Update the status of the change request",
"description" : "",
"operationId" : "updateChange",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Display ID of the change ticket to update.",
"required" : true,
"type" : "string",
"x-example" : "CRQ000000000001"
}, {
"in" : "body",
"name" : "Change request",
"description" : "Change request object with fields which needs to be updated",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Change"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/foundation/V2/supportGroups" : {
"post" : {
"tags" : [ "Foundation resource" ],
"summary" : "Get person support Groups details based on Person Id",
"description" : "",
"operationId" : "getSupportGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "SearchCriteria",
"description" : "Search criteria for getting Support Groups",
"required" : false,
"schema" : {
"$ref" : "#/definitions/SearchCriteria"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Person"
}
}
}
}
},
"/v2/incident" : {
"post" : {
"tags" : [ "Incident resource" ],
"summary" : "Creates the specified incident ticket.",
"description" : "",
"operationId" : "createIncident",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "Incident",
"description" : "Incident object with fields which needs to be created",
"required" : true,
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/incident/search" : {
"post" : {
"tags" : [ "Incident resource" ],
"summary" : "Get incident ticket details based on passed query filter criteria",
"description" : "",
"operationId" : "getIncidentDetails",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "SearchCriteria",
"description" : "Search criteria for incident ticket",
"required" : false,
"schema" : {
"$ref" : "#/definitions/SearchCriteria"
}
}, {
"name" : "filter",
"in" : "query",
"description" : "Filter your search based on Assigned Groups and so on.",
"required" : false,
"type" : "string",
"x-example" : "My Group Tickets"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/incident/{id}" : {
"get" : {
"tags" : [ "Incident resource" ],
"summary" : "Get incident details based on Instance Id",
"description" : "",
"operationId" : "getIncidentById",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "ID of the incident ticket to update.",
"required" : true,
"type" : "string",
"x-example" : "INC000000000102"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Incident resource" ],
"summary" : "Updates the specified incident ticket.",
"description" : "",
"operationId" : "updateIncident",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Display ID of incident ticket to update.",
"required" : true,
"type" : "string",
"x-example" : "INC000000000102"
}, {
"in" : "body",
"name" : "Incident",
"description" : "Incident object with fields which needs to be updated",
"required" : true,
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/incident/{id}/recommended/{ticketType}" : {
"get" : {
"tags" : [ "Incident resource" ],
"summary" : "Get recommended knowledge articles or incidents based on instance ID.",
"description" : "",
"operationId" : "getRelatedArticlesForIncident",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Incident ID for which you want to retrieve recommended knowledge articles or incidents.",
"required" : true,
"type" : "string",
"x-example" : "INC000000000102"
}, {
"name" : "ticketType",
"in" : "path",
"description" : "Related ticket type to retrieve.",
"required" : true,
"type" : "string",
"enum" : [ "incident", "knowledge" ],
"x-example" : "knowledge OR incident"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/person/permission" : {
"get" : {
"tags" : [ "Person resource" ],
"summary" : "Get permission details of logged in user",
"description" : "",
"operationId" : "getPermission",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "user",
"in" : "query",
"description" : "User name of the logged in user.",
"required" : false,
"type" : "string",
"x-example" : "Allen"
}, {
"name" : "permissiontype",
"in" : "query",
"description" : "specify application/user permission",
"required" : false,
"type" : "string",
"x-example" : "applicationpermission/userpermission"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Person"
}
}
}
}
},
"/v2/person/{id}" : {
"get" : {
"tags" : [ "Person resource" ],
"summary" : "Get person details based on Person Id",
"description" : "",
"operationId" : "getPersonById",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "User ID",
"required" : true,
"type" : "string",
"x-example" : "Allen"
}, {
"name" : "fetchSupportGroups",
"in" : "query",
"description" : "Fetch support groups for the Person",
"required" : false,
"type" : "string",
"x-example" : "Y/N"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Person"
}
}
}
}
},
"/v2/problem" : {
"post" : {
"tags" : [ "Problem resource" ],
"summary" : "Creates the specified problem ticket.",
"description" : "",
"operationId" : "createProblem",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "Problem",
"description" : "Problem object with fields which needs to be created",
"required" : true,
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/problem/search" : {
"post" : {
"tags" : [ "Problem resource" ],
"summary" : "Get Problem ticket details based on passed query filter criteria",
"description" : "",
"operationId" : "getProblemDetails",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "SearchCriteria",
"description" : "Search Criteria for search.",
"required" : false,
"schema" : {
"$ref" : "#/definitions/SearchCriteria"
}
}, {
"name" : "filter",
"in" : "query",
"description" : "Filter your search based on Assigned Groups and so on.",
"required" : false,
"type" : "string",
"x-example" : "My Group Need Attention Tickets"
}, {
"name" : "optimize",
"in" : "query",
"description" : "search result will be optimized to return only ids for subentities like person,customer,attachments for performance improvement",
"required" : false,
"type" : "string",
"x-example" : "Y/N"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/problem/{id}" : {
"get" : {
"tags" : [ "Problem resource" ],
"summary" : "Get problem details based on Instance Id",
"description" : "",
"operationId" : "getProblemById",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "ID of the problem ticket.",
"required" : true,
"type" : "string",
"x-example" : "PBI_CAL_1000024"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Problem resource" ],
"summary" : "Update the status of the problem",
"description" : "",
"operationId" : "updateProblem",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Display Id of problem ticket to update.",
"required" : true,
"type" : "string",
"x-example" : "PBI000000000102"
}, {
"in" : "body",
"name" : "Incident",
"description" : "Incident object with fields which needs to be updated",
"required" : true,
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/problem/{id}/recommended/{ticketType}" : {
"get" : {
"tags" : [ "Problem resource" ],
"summary" : "Get recommended Knowledge Articles based on Instance Id",
"description" : "",
"operationId" : "getRelatedArticlesForProblem",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Incident Display ID for which you want to fetch recommended knowledge articles.",
"required" : true,
"type" : "string",
"x-example" : "INC000000000102"
}, {
"name" : "ticketType",
"in" : "path",
"description" : "Related ticket types that you want to retrieve.",
"required" : true,
"type" : "string",
"enum" : [ "incident", "knowledge" ],
"x-example" : "knowledge"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/ticket/search" : {
"post" : {
"tags" : [ "Ticket Search resource." ],
"summary" : "Get ticket details based on passed query filter criteria",
"description" : "",
"operationId" : "getTicketDetails",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "filter",
"in" : "query",
"description" : "filter to search based on Assigned Groups etc",
"required" : false,
"type" : "string"
}, {
"in" : "body",
"name" : "SearchCriteria",
"description" : "Search Criteria to be passed for search",
"required" : false,
"schema" : {
"$ref" : "#/definitions/SearchCriteria"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/v2/worknote/{type}/{id}" : {
"get" : {
"tags" : [ "WorkNote Resource" ],
"summary" : "Get work notes by type and id",
"description" : "",
"operationId" : "get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "type",
"in" : "path",
"description" : "Type of ticket",
"required" : true,
"type" : "string",
"enum" : [ "incident", "problem", "change" ]
}, {
"name" : "id",
"in" : "path",
"description" : "Id of ticket",
"required" : true,
"type" : "string"
}, {
"name" : "startIndex",
"in" : "query",
"description" : "Start index",
"required" : false,
"type" : "integer",
"format" : "int32"
}, {
"name" : "pageSize",
"in" : "query",
"description" : "Page size",
"required" : false,
"type" : "integer",
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "Response of type List of WorkNote",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/WorkNote"
}
}
}
}
},
"post" : {
"tags" : [ "WorkNote Resource" ],
"summary" : "Api add a work note",
"description" : "",
"operationId" : "addWorkNote",
"consumes" : [ "multipart/form-data" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "type",
"in" : "path",
"description" : "type",
"required" : true,
"type" : "string"
}, {
"name" : "id",
"in" : "path",
"description" : "id",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"required" : false,
"schema" : {
"$ref" : "#/definitions/FormDataMultiPart"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/WorkNote"
}
}
}
}
}
},
"definitions" : {
"AttachmentReference" : {
"type" : "object",
"properties" : {
"dataSource" : {
"type" : "string",
"description" : "Form name where attachemnt is present"
},
"attachmentFieldId" : {
"type" : "string",
"description" : "Field Id of the attachemnt"
},
"dataSourceId" : {
"type" : "string",
"description" : "Record ID where this attachment is present"
}
},
"description" : "AttachmentReference - Info about attachment"
},
"Attachments" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"fileSize" : {
"type" : "integer",
"format" : "int64"
},
"thumbnail" : {
"type" : "string"
},
"fileContentType" : {
"type" : "string"
},
"fileName" : {
"type" : "string"
},
"downloadUrl" : {
"type" : "string"
},
"attachmentReference" : {
"$ref" : "#/definitions/AttachmentReference"
}
}
},
"BasicCondition" : {
"type" : "object",
"properties" : {
"fieldName" : {
"type" : "string",
"example" : "id/status/summary",
"description" : "camelCase fieldName of the form field"
},
"fieldValue" : {
"type" : "string",
"example" : "INC00000001 for id or 1 for status",
"description" : "value for the field"
},
"fieldType" : {
"type" : "string",
"example" : "int/string. if status value is 1 then type will be int",
"description" : "type of the value for the field"
},
"operation" : {
"type" : "string",
"example" : "eq/contains/lt/gt",
"description" : "Operation for comparison e.g. equal/contains"
},
"bindingExpression" : {
"type" : "string",
"example" : "OR",
"description" : "AND/OR operator for Filter"
},
"conditions" : {
"type" : "array",
"example" : "{\r\n \"fieldName\": \"status\",\r\n \"operation\": \"eq\",\r\n \"fieldValue\": \"27000\"\r\n },\r\n {\r\n \"fieldName\": \"assignee\",\r\n \"operation\": \"eq\",\r\n \"fieldValue\": \"Allen Allbrook\"\r\n }",
"description" : "List of conditions to form criteria",
"items" : {
"$ref" : "#/definitions/BasicCondition"
}
}
}
},
"BodyPart" : {
"type" : "object",
"properties" : {
"contentDisposition" : {
"$ref" : "#/definitions/ContentDisposition"
},
"entity" : {
"type" : "object"
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"mediaType" : {
"$ref" : "#/definitions/MediaType"
},
"messageBodyWorkers" : {
"$ref" : "#/definitions/MessageBodyWorkers"
},
"parent" : {
"$ref" : "#/definitions/MultiPart"
},
"providers" : {
"$ref" : "#/definitions/Providers"
},
"parameterizedHeaders" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ParameterizedHeader"
}
}
}
}
},
"Change" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"guid" : {
"type" : "string"
},
"instanceId" : {
"type" : "string"
},
"summary" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"locationCompany" : {
"type" : "string"
},
"createDate" : {
"type" : "string"
},
"modifiedDate" : {
"type" : "string"
},
"type" : {
"type" : "integer",
"format" : "int32"
},
"status" : {
"type" : "integer",
"format" : "int32"
},
"statusReason" : {
"type" : "integer",
"format" : "int32"
},
"resolutionNote" : {
"type" : "string"
},
"priority" : {
"type" : "integer",
"format" : "int32"
},
"impact" : {
"type" : "integer",
"format" : "int32"
},
"urgency" : {
"type" : "integer",
"format" : "int32"
},
"customer" : {
"$ref" : "#/definitions/Person"
},
"assignee" : {
"$ref" : "#/definitions/Person"
},
"assigneeGroupId" : {
"type" : "string"
},
"assigneeGroup" : {
"type" : "string"
},
"needsAttention" : {
"type" : "boolean",
"default" : false
},
"fields" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"launchUrl" : {
"type" : "string"
},
"attachments" : {
"type" : "array",
"description" : "ticket attachment details",
"items" : {
"$ref" : "#/definitions/Attachments"
}
},
"targetDate" : {
"type" : "string",
"description" : "target date of the ticket"
},
"assigneeSupportOrganization" : {
"type" : "string",
"description" : "assigneeSupportOrganization of problem"
},
"assigneeSupportCompany" : {
"type" : "string",
"description" : "assigneeSupportCompany of problem"
},
"class" : {
"type" : "integer",
"format" : "int32",
"description" : "Class / type of change request"
},
"scheduleStartDate" : {
"type" : "string",
"description" : "Schedule Start Date of change request"
},
"scheduleEndDate" : {
"type" : "string",
"description" : "Schedule End Date of change request"
},
"actualStartDate" : {
"type" : "string",
"description" : "Actual Start Date of change request"
},
"actualEndDate" : {
"type" : "string",
"description" : "Actual End Date of change request"
},
"affectedService" : {
"type" : "string",
"description" : "affectedService of change request"
},
"requestedFor" : {
"description" : "requestedFor of change request",
"$ref" : "#/definitions/Person"
},
"coordinator" : {
"description" : "coordinator of change request",
"$ref" : "#/definitions/Person"
},
"coordinatorGroupId" : {
"type" : "string",
"description" : "coordinatorGroupId of change request"
},
"coordinatorGroup" : {
"type" : "string",
"description" : "coordinatorGroup of change request"
},
"coordinatorGroupOrganization" : {
"type" : "string",
"description" : "coordinator Group organization of change request"
},
"coordinatorGroupCompany" : {
"type" : "string",
"description" : "coordinatorGroupCompany of change request"
},
"changeManager" : {
"description" : "change manager of change request",
"$ref" : "#/definitions/Person"
},
"changeManagerGroupId" : {
"type" : "string",
"description" : "change manager groupId of change request"
},
"changeManagerGroup" : {
"type" : "string",
"description" : "change Manager group of change request"
},
"changeManagerGroupOrganization" : {
"type" : "string",
"description" : "change manager group organization of change request"
},
"changeManagerGroupCompany" : {
"type" : "string",
"description" : "change manager group company of change request"
}
},
"description" : "Change object for incident selection values."
},
"ContentDisposition" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"fileName" : {
"type" : "string"
},
"creationDate" : {
"type" : "string",
"format" : "date-time"
},
"modificationDate" : {
"type" : "string",
"format" : "date-time"
},
"readDate" : {
"type" : "string",
"format" : "date-time"
},
"size" : {
"type" : "integer",
"format" : "int64"
}
}
},
"Criteria" : {
"type" : "object",
"required" : [ "bindingExpression", "conditions" ],
"properties" : {
"bindingExpression" : {
"type" : "string",
"example" : "AND",
"description" : "AND/OR operator for Filter"
},
"conditions" : {
"type" : "array",
"example" : "{\r\n \"fieldName\": \"status\",\r\n \"operation\": \"eq\",\r\n \"fieldValue\": \"27000\"\r\n },\r\n {\r\n \"fieldName\": \"assignee\",\r\n \"operation\": \"eq\",\r\n \"fieldValue\": \"Allen Allbrook\"\r\n }",
"description" : "List of conditions to form criteria",
"items" : {
"$ref" : "#/definitions/BasicCondition"
}
}
}
},
"FieldMeta" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of field contained"
},
"fieldMenuItems" : {
"type" : "array",
"description" : "List of all Menu Item values associated with this field.",
"items" : {
"$ref" : "#/definitions/MenuMeta"
}
},
"selectionValues" : {
"type" : "array",
"description" : "List of all Selection Item values associated with this field.",
"items" : {
"$ref" : "#/definitions/SelectionMeta"
}
}
},
"description" : "Meta data for containing Fields info. It will contain all selection and list values."
},
"FormDataBodyPart" : {
"type" : "object",
"properties" : {
"contentDisposition" : {
"$ref" : "#/definitions/ContentDisposition"
},
"entity" : {
"type" : "object"
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"mediaType" : {
"$ref" : "#/definitions/MediaType"
},
"messageBodyWorkers" : {
"$ref" : "#/definitions/MessageBodyWorkers"
},
"parent" : {
"$ref" : "#/definitions/MultiPart"
},
"providers" : {
"$ref" : "#/definitions/Providers"
},
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
},
"formDataContentDisposition" : {
"$ref" : "#/definitions/FormDataContentDisposition"
},
"simple" : {
"type" : "boolean",
"default" : false
},
"parameterizedHeaders" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ParameterizedHeader"
}
}
}
}
},
"FormDataContentDisposition" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"fileName" : {
"type" : "string"
},
"creationDate" : {
"type" : "string",
"format" : "date-time"
},
"modificationDate" : {
"type" : "string",
"format" : "date-time"
},
"readDate" : {
"type" : "string",
"format" : "date-time"
},
"size" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
}
}
},
"FormDataMultiPart" : {
"type" : "object",
"properties" : {
"contentDisposition" : {
"$ref" : "#/definitions/ContentDisposition"
},
"entity" : {
"type" : "object"
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"mediaType" : {
"$ref" : "#/definitions/MediaType"
},
"messageBodyWorkers" : {
"$ref" : "#/definitions/MessageBodyWorkers"
},
"parent" : {
"$ref" : "#/definitions/MultiPart"
},
"providers" : {
"$ref" : "#/definitions/Providers"
},
"bodyParts" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BodyPart"
}
},
"fields" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FormDataBodyPart"
}
}
},
"parameterizedHeaders" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ParameterizedHeader"
}
}
}
}
},
"MediaType" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"subtype" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"wildcardType" : {
"type" : "boolean",
"default" : false
},
"wildcardSubtype" : {
"type" : "boolean",
"default" : false
}
}
},
"MenuMeta" : {
"type" : "object",
"properties" : {
"labels" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"value" : {
"type" : "string"
}
},
"description" : "Menu Item values associated with this field."
},
"MessageBodyWorkers" : {
"type" : "object"
},
"MultiPart" : {
"type" : "object",
"properties" : {
"contentDisposition" : {
"$ref" : "#/definitions/ContentDisposition"
},
"entity" : {
"type" : "object"
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"mediaType" : {
"$ref" : "#/definitions/MediaType"
},
"messageBodyWorkers" : {
"$ref" : "#/definitions/MessageBodyWorkers"
},
"parent" : {
"$ref" : "#/definitions/MultiPart"
},
"providers" : {
"$ref" : "#/definitions/Providers"
},
"bodyParts" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BodyPart"
}
},
"parameterizedHeaders" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ParameterizedHeader"
}
}
}
}
},
"ParameterizedHeader" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
},
"Person" : {
"type" : "object",
"properties" : {
"loginId" : {
"type" : "string",
"description" : "loginId of person"
},
"firstName" : {
"type" : "string",
"description" : "firstName of person"
},
"lastName" : {
"type" : "string",
"description" : "lastName of person"
},
"fullName" : {
"type" : "string",
"description" : "fullName of person"
},
"company" : {
"type" : "string",
"description" : "company of person"
},
"permission" : {
"type" : "array",
"description" : "permission of person",
"items" : {
"type" : "string"
}
},
"assigneeSupportGroups" : {
"type" : "array",
"description" : "assigned groups of person",
"items" : {
"$ref" : "#/definitions/SupportGroup"
}
}
},
"description" : "Person object for person fields values."
},
"Providers" : {
"type" : "object"
},
"RequiredField" : {
"type" : "object",
"properties" : {
"fieldName" : {
"type" : "string",
"example" : "id/status/summary",
"description" : "camelCase fieldName of the form field"
},
"criteria" : {
"example" : "10",
"description" : "Criteria object with conditions",
"$ref" : "#/definitions/Criteria"
}
}
},
"SearchCriteria" : {
"type" : "object",
"properties" : {
"limit" : {
"type" : "integer",
"format" : "int32",
"example" : 10,
"description" : "Any integer value"
},
"offset" : {
"type" : "integer",
"format" : "int32",
"example" : 10,
"description" : "Any integer value"
},
"sortBy" : {
"type" : "array",
"example" : "priority",
"description" : "sortBy column name",
"items" : {
"$ref" : "#/definitions/SortBy"
}
},
"fields" : {
"type" : "array",
"example" : "['id','status']",
"description" : "comma separated field ids",
"items" : {
"type" : "string"
}
},
"criteria" : {
"example" : "10",
"description" : "Criteria object with conditions",
"$ref" : "#/definitions/Criteria"
}
}
},
"SelectionMeta" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"value" : {
"type" : "string"
}
},
"description" : "List of all Selection Item values associated with this field."
},
"SortBy" : {
"type" : "object",
"properties" : {
"field" : {
"type" : "string",
"example" : "id/status/summary",
"description" : "camelCase field of the form field to sort"
},
"order" : {
"type" : "string",
"example" : "asc/desc",
"description" : "sort order for the field Ascending/Descending"
}
}
},
"StatusMetaBase" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32",
"description" : "Status id to be mapped"
},
"value" : {
"type" : "string",
"description" : "Status name to be mapped"
},
"alias" : {
"type" : "string"
},
"statusReasons" : {
"type" : "array",
"description" : "Possible status reasons to be mapped",
"items" : {
"$ref" : "#/definitions/SelectionMeta"
}
},
"invalidStatusTransitions" : {
"type" : "array",
"description" : "Possible status transitions to be mapped",
"items" : {
"$ref" : "#/definitions/StatusTransition"
}
}
},
"description" : "Meta data Object for status mappings. This object contains status mapping with reasons and possible invalid transitions list."
},
"StatusTransition" : {
"type" : "object",
"properties" : {
"toStatusId" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "Denotes invalid status transition from parent object to this object."
},
"SupportGroup" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"company" : {
"type" : "string"
},
"organization" : {
"type" : "string"
},
"defaultGroup" : {
"type" : "boolean",
"default" : false
},
"available" : {
"type" : "boolean",
"default" : false
},
"functionalRole" : {
"type" : "string"
}
}
},
"TicketMetaData" : {
"type" : "object",
"properties" : {
"fields" : {
"type" : "object",
"description" : "List of fields contained within the Metadata",
"additionalProperties" : {
"$ref" : "#/definitions/FieldMeta"
}
},
"statusMappings" : {
"type" : "array",
"description" : "List of statuses mapped to status reasons and status transitions.",
"items" : {
"$ref" : "#/definitions/StatusMetaBase"
}
},
"requiredFields" : {
"type" : "array",
"description" : "List of required fields while updating ticket.",
"items" : {
"$ref" : "#/definitions/RequiredField"
}
},
"workNote" : {
"description" : "Work note item possible values for given Ticket type.",
"$ref" : "#/definitions/WorkNoteMeta"
}
},
"description" : "Includes meta data for Ticket selection values."
},
"WorkNote" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"activityType" : {
"type" : "string"
},
"note" : {
"type" : "string"
},
"createDate" : {
"type" : "string"
},
"submitter" : {
"type" : "string"
},
"viewAccess" : {
"type" : "boolean",
"default" : false
},
"attachmentCount" : {
"type" : "integer",
"format" : "int32"
},
"attachments" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Attachments"
}
}
}
},
"WorkNoteMeta" : {
"type" : "object",
"properties" : {
"types" : {
"type" : "array",
"description" : "List of work note Type values.",
"items" : {
"$ref" : "#/definitions/SelectionMeta"
}
}
},
"description" : "Includes list of work note Types"
}
}
}
To download the simplified REST API specification, click swagger.json.