Jira Service Desk Connector Objects

This Data Cloud connector is a beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.
NameDescription
CustomersThis resource represents a customer.
CustomerTransitionsReturns a list of transitions that customers can perform on the request.
KnowledgeBaseArticlesThe articles which match the given query string across all service desks.
OrganizationsThis resource represents an organization.
RequestApprovalsThis resource represents a request approval.
RequestCommentsThis resource represents request comments.
RequestParticipantsThis resource represents request participants.
RequestsThis resource represents a request.
RequestSLACyclesThis resource represents the SLAs (service level agreements) on a customer request.
RequestStatusChangelogThis resource represents the status transitions for a customer request.
RequestTypeFieldsThe fields for a service desk's customer request type.
RequestTypeGroupsThis resource represents a request type group.
RequestTypesThis resource represents a request type.
SampleQueueRequestsThis resource returns the customer requests in a queue.
ServiceDesksThis resource represents a service desk. A service desk is based on a project in the JIRA platform, and is used to manage customer requests.
UsersThis resource represents a user.
NameTypeReadOnlyReferencesFilterOnlyDescription
AccountId [KEY]StringFalseNoThe Id of the account.
ActiveBooleanFalseNoShows if the customer is active.
DisplayNameStringFalseNoThe Display Name of the customer.
EmailAddressStringFalseNoThe email address of the customer.
TimeZoneStringFalseNoThe time zone of the customer.
ServiceDeskIdStringFalseServiceDesks.IdNoThe Id of the service desk.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RequestId [KEY]StringTrueNoThe ID of the request.
RequestKeyStringTrueNoThe Key of the request.
Id [KEY]StringFalseNoThe Id of the transition.
NameStringTrueNoThe Name of the customer transition.
CommentStringFalseNoThe body of the comment for the transition.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceDeskIdStringFalseServiceDesks.IdNoThe Id of the service desk.
TitleStringFalseNoThe title of the article.
ExcerptStringFalseNoThe excerpt of the article.
SourceTypeStringFalseNoThe article's source type
SourcePageIdStringFalseNoThe article's source page id
SourceSpaceKeyStringFalseNoThe article's source space key
ContentiFramesourceStringFalseNoThe link to the article.
QueryStringFalseNoThe string used to filter the articles (required).
HighlightBooleanFalseYesIf set to true matching query term in the title and excerpt will be highlighted using the {@code @@@hl@@@term@@@endhl@@@} syntax. Default: false.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the organization.
NameStringFalseNoThe Name of the organization.
ServiceDeskIdStringFalseServiceDesks.IdNoThe Id of the service desk.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the approval.
RequestKeyStringTrueNoThe Id of the request.
RequestId [KEY]StringTrueNoThe Key of the request.
Name [KEY]StringTrueNoThe Name of the approval.
FinalDecisionStringFalseNoThe final decision.
CanAnswerApprovalStringTrueNoShows if this approval can be answered.
ApproversStringTrueNoThe approvers of this request.
CreatedDateStringTrueNoThe datetime this request was approved.
CompletedDateStringTrueNoThe datetime this request approval was created.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe Id of the comment.
RequestId [KEY]StringTrueNoThe Id of the request.
RequestKeyStringTrueNoThe Key of the request.
BodyStringFalseNoThe Body of the comment.
PublicBooleanTrueNoShows if the comment is public or internal
AuthorKeyStringTrueNoThe key of the comment author.
CreatedAtStringTrueNoThe datetime the comment was created.
InternalBooleanFalseYesSpecifies whether to return internal comments or not. Default: true.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountId [KEY]StringTrueNoThe Account Id of the participant.
RequestId [KEY]StringTrueNoThe ID of the Request.
RequestKeyStringTrueNoThe Key of the request.
EmailAddressStringTrueNoThe Email address of the participant.
DisplayNameStringTrueNoThe display name of the participant.
ActiveBooleanTrueNoShows if a participant is active.
TimeZoneStringTrueNoThe time zone of the participant.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RequestId [KEY]StringTrueNoThe ID of the request.
RequestKey [KEY]StringTrueNoThe Key of the request.
RequestTypeIdStringFalseNoThe ID of the request type.
ServiceDeskIdStringFalseNoThe Id of the service desk.
CreatedDateStringTrueNoThe date when the request is created.
ReporterKeyStringTrueNoThe key of the reporter.
ReporterDisplayNameStringTrueNoThe display name of the reporter.
ReporterEmailStringTrueNoThe email of the reporter.
ReporterNameStringTrueNoThe name of the reporter.
ReporterTimeZoneStringTrueNoThe time zone of the reporter.
CurrentStatusStringTrueNoThe current status of the request.
RequestParticipantsStringTrueNoThe participants of the request.
RequestOwnershipStringFalseYesThe owner of the request.
RequestStatusStringFalseYesThe status of the request.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe ID of the SLA.
RequestId [KEY]StringFalseNoThe Id of the request.
RequestKey [KEY]StringFalseNoThe Key of the request.
NameStringFalseNoThe Name of the cycle.
OngoingCycleStartTimeDatetimeFalseNoTime and date at which the SLA cycle started.
OngoingCycleBreachedBooleanFalseNoIndicates whether the SLA has been breached or not.
OngoingCycleBreachTimeDatetimeFalseNoTime and date at which the SLA cycle would have breached its limit.
OngoingCyclePausedBooleanFalseNoIndicates whether the SLA is paused or not.
OngoingCycleWithinCalendarHoursBooleanFalseNoIndicates whether the SLA it timed during calendared working hours only or not
OngoingCycleGoalDurationStringFalseNoDuration within which the service should be completed.
OngoingCycleElapsedTimeStringFalseNoDuration of the service.
OngoingCycleRemainingTimeStringFalseNoDuration remaining for the service to be completed.
CompletedCycleStartTimeDatetimeFalseNoTime and date at which the SLA cycle started.
CompletedCycleStopTimeDatetimeFalseNoTime and date at which the SLA cycle completed.
CompletedCycleBreachedBooleanFalseNoIndicates whether the SLA has been breached or not.
CompletedCycleBreachTimeDatetimeFalseNoTime and date at which the SLA cycle breached in case of completed breached cycle or would have breached in case of non-breached completed cycle.
CompletedCycleGoalDurationStringFalseNoDuration within which the service should have been completed.
CompletedCycleElapsedTimeStringFalseNoDuration in which the service was completed.
CompletedCycleRemainingTimeStringFalseNoDuration remaining after the service was completed.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RequestId [KEY]StringFalseNoThe Id of the request.
RequestKey [KEY]StringFalseNoThe Key of the request.
StatusStringFalseNoThe status of the request.
StatusDateDatetimeFalseNoThe date of the request status.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ServiceDeskIdStringFalseServiceDesks.IdNoThe ID of the service desk containing the request types whose fields are to be returned.
RequestTypeIdStringFalseRequestTypes.IdNoThe ID of the request types whose fields are to be returned.
FieldIdStringFalseNoID of the field.
NameStringFalseNoName of the field.
DescriptionStringFalseNoDescription of the field.
RequiredBooleanFalseNoIndicates if the field is required (true) or not (false).
JiraSchemaStringFalseNoJira specific implementation details for the field in the UI.
ValidValuesStringFalseNoList of valid values for the field.
DefaultValuesStringFalseNoList of default values for the field.
VisibleBooleanFalseNoBoolean incidating if the field is visible.
ExpandStringFalseYesUse expand to include additional information in the response. This parameter accepts hiddenFields that returns hidden fields associated with the request type.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the request type group.
ServiceDeskId [KEY]StringFalseServiceDesks.IdNoThe Id of the service desk.
NameStringFalseNoThe Name of the request type group.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe ID of the request type.
ServiceDeskId [KEY]StringFalseServiceDesks.IdNoThe Id of the service desk.
GroupIdsStringFalseNoThe IDs of the groups that this request type is part of.
NameStringFalseNoThe Name of the request type.
DescriptionStringFalseNoThe description of the request type.
PortalIdStringFalseNoThe Id of the customer portal associated with the service desk project.
IssueTypeIdStringFalseNoThe Id of the issue type the request type is based upon.
SearchQueryStringFalseYesString to be used to filter the results.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RequestId [KEY]StringFalseNoThe ID of the request.
RequestKey [KEY]StringFalseNoThe Key of the request.
SummaryStringFalseNoThe summary of the request.
StatusStringFalseNoThe status of the request.
CreatedDatetimeFalseNoThe date the request was created.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the service desk.
ProjectIdStringFalseNoThe ID of the project.
ProjectNameStringFalseNoThe name of the project.
ProjectKeyStringFalseNoThe key of the project.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountId [KEY]StringFalseNoThe Account Id of the user.
OrganizationId [KEY]StringFalseOrganizations.IdNoThe ID of the organization.
EmailAddressStringFalseNoThe Email address of the user.
DisplayNameStringFalseNoThe display name of the user.
ActiveBooleanFalseNoShows if a user is active.
TimeZoneStringFalseNoThe time zone of the user.

Return to Top