zAgileConnect API Reference (Beans)

ZCBeans Classes

ZCBeans

Common Beans for zAgileConnect API

ZCBeans.AttachmentRequestResult

The result of attaching a file on Issue operation returned by a ZC API method

Methods:

AttachmentRequestResult(String errorMessage)

Constructor when the result is not successful

AttachmentRequestResult()

Constructor when the result is successful

String getErrorMessage()

Returns error message

Return Value:
String errorMessage

Boolean hasError()

Returns true if there is at least one error message

Return Value:
Boolean

ZCBeans.AvailableTransitionsResult

The result of retrieving available transitions

Methods:

AvailableTransitionsResult(Map<String, Object> transitionsData, String errorMessage)

Constructor, builds result using the transition data pulled from Jira.

TransitionIssueBean buildIssueTransitionFromName(String transitionName)

Returns a TransitionIssueBean with a given transition name

Return Value:
TransitionIssueBean with transitions data available

List<String> getAvailableTransitionsNames()

Returns available Transition names

Return Value:
List possible Transitions Issue can take

String getErrorMessage()

Error Returns error message from Jira.

Return Value:
String errorMessage

Map<String, Object> getTransitionsData()

Returns Transitions metadata

Return Value:
Map with raw data about transitions returned by JIRA Service

Boolean hasError()

Returns if there was a problem pulling available transitions

Return Value:
True if exists any error message

ZCBeans.GenericErrorMessage

Error message object used to post API errors on Salesforce Entity (Supports Case only)

Methods:

void addErrorMessage(String errorMessage)

Adds error message

Parameters:

• String errorMessage

GenericErrorMessage(Id entityId, String errorMessage)

Constructor for a single error message

Parameters:

• Id entityId Salesforce object ID where the error will be posted

• String errorMessage

GenericErrorMessage(Id entityId, List<String> errorMessages)

Constructor for a list of error messages

Parameters:

• Id entityId Salesforce object ID where the errors will be posted

• List<String> errorMessages

List<String> getErrorMessages()

Returns the error messages

Return Value:
List<String> errorMessages

ZCBeans.IdIssueFieldValue

Issue field value represented by ID attribute

Methods:

String getId()

Returns ID

Return Value:
String Id

IdIssueFieldValue(String id)

Contructor for object that represents a Jira field of type Id.

void setId(String id)

Sets ID value

Parameters:

• String id

override String toString()

returns the representation of the field in String

Return Value:
the string representation.

ZCBeans.IssueCommentResult

The result of comment on Issue operation returned by a ZC API method

Properties:

Methods:

String getErrorMessage()

Returns error message

Return Value:
String errorMessage

String getIssueCommentId()

Returns Issue comment ID

Return Value:
String issueCommentId

Boolean hasError()

Returns true if there is at least one error message

Return Value:
Boolean

IssueCommentResult(String issueKeyOrId, String issueCommentId)

Constructor, it builds a result with successful and relevant information

IssueCommentResult(String issueKeyOrId, String issueCommentId, String errorMessage)

Constructor, it builds a bean when the result is not successful

ZCBeans.IssueDeleteResult

The result of delete Issue operation returned by a ZC API method

Methods:

IssueDeleteResult(String issueKey)

Constructor, it builds a bean when the result is successful

IssueDeleteResult(String issueKey, String errorMessage)

Constructor, it builds a bean when the result is not successful

ZCBeans.IssueLinkUnlinkDeleteResult

Properties:

Methods:

Boolean hasError()

Indicate whether the given response has any errors.

Return Value:
true if the response indicates an error; false otherwise

ZCBeans.IssueLinkUnlinkResult

Methods:

IssueLinkUnlinkResult(String issueKey)

Constructor, it builds a bean when the result is successful

IssueLinkUnlinkResult(String issueKey, String errorMessage)

Constructor, it builds a bean when the result is not successful

ZCBeans.IssueTemplate

The template to create or update an Issue

Methods:

void addAffectVersion(NameOrIdIssueFieldValue version)

Adds an Issue affects version value

Parameters:

• NameOrIdIssueFieldValue version

void addComponent(NameOrIdIssueFieldValue component)

Adds an Issue component

Parameters:

• NameOrIdIssueFieldValue component

void addCustomField(String field, Object value)

Adds an Issue custom field

Parameters:

• String field

• Object value of the custom field with the structure as expected by the JIRA REST API

void addFixVersion(NameOrIdIssueFieldValue fixVersion)

Adds an Issue fix version value

Parameters:

• NameOrIdIssueFieldValue fixVersion

void addLabel(String label)

Adds an Issue label

Parameters:

• String label

List<NameOrIdIssueFieldValue> getAffectVersions()

Returns Issue affects versions

Return Value:
List<NameOrIdIssueFieldValue> versions

NameIssueFieldValue getAssignee()

Returns Issue assignee. Deprecated, If it is being used accountId for assignee representation use getIssueAssignee instead

Return Value:
NameIssueFieldValue assignee

List<NameOrIdIssueFieldValue> getComponents()

Returns Issue components

Return Value:
List<NameOrIdIssueFieldValue> components

Map<String, Object> getCustomFields()

Returns Issue custom fields

Return Value:
Map<String,Object> customFields

String getDescription()

Returns Issue description

Return Value:
String description

String getDuedate()

Returns due date

Return Value:
String dueDate

String getEnvironment()

Returns Issue environment

Return Value:
String environment

List<NameOrIdIssueFieldValue> getFixVersions()

Returns Issue fix versions

Return Value:
List<NameOrIdIssueFieldValue> fixVersions

NameOrIdIssueFieldValue getIssueAssignee()

Returns Issue assignee

Return Value:
NameOrIdIssueFieldValue assignee

NameOrIdIssueFieldValue getIssueReporter()

Returns Issue reporter

Return Value:
NameOrIdIssueFieldValue reporter

NameOrIdIssueFieldValue getIssueType()

Returns the JIRA issue type Name or ID

Return Value:
NameOrIdIssueFieldValue issueType

List<String> getLabels()

Returns Issue labels

Return Value:
List<String> labels

NameOrIdIssueFieldValue getPriority()

Returns the Issue priority

Return Value:
NameOrIdIssueFieldValue priority

KeyOrIdIssueFieldValue getProject()

Returns the JIRA project key or ID

Return Value:
KeyOrIdIssueFieldValue project

NameIssueFieldValue getReporter()

Returns Issue reporter. Deprecated, If it is being used accountId for reporter representation use getIssueReporter instead

Return Value:
NameIssueFieldValue reporter

String getSummary()

Returns Issue summary

Return Value:
String summary

IssueTemplate(String issueKey)

Constructor to create an Issue template for issue update from scratch

Parameters:

• issueKey Issue key

IssueTemplate(Id entityId)

Constructor to create an Issue template for issue create from scratch

Parameters:

• entityId Salesforce object entity ID. The created issue will be linked to this entity.

void setAffectVersions(List<NameOrIdIssueFieldValue> versions)

Sets Issue affects versions

Parameters:

• List<NameOrIdIssueFieldValue> versions

void setAssignee(NameIssueFieldValue assignee)

Sets Issue assignee. Deprecated, If it is being used accountId for assignee representation use setIssueAssignee instead

Parameters:

• NameIssueFieldValue assignee name field value

void setComponents(List<NameOrIdIssueFieldValue> components)

Sets issue components

Parameters:

• List<NameOrIdIssueFieldValue> components

void setCustomFields(Map<String, Object>customFields)

Sets Issue custom fields using a Map of field values

Parameters:

• Map<String,Object> customFields

void setDescription(String description)

Sets Issue description

Parameters:

• String description

void setDuedate(Date duedate)

Sets Issue due date

Parameters:

• Date dueDate

void setDuedateString(String duedate)

Sets Issue due date

Parameters:

• String dueDate

void setEntityId(Id entityId)

Sets the Salesforce object entity ID. The created issue will be linked to this entity.

Parameters:

• Id entityId

void setEnvironment(String environment)

Sets Issue environment

Parameters:

• String environment

void setFixVersions(List<NameOrIdIssueFieldValue> fixVersions)

Sets Issue fix versions

Parameters:

• List<NameOrIdIssueFieldValue> fixVersions

void setIssueAssignee(NameOrIdIssueFieldValue assignee)

Sets Issue assignee

Parameters:

• NameOrIdIssueFieldValue assignee name field value

void setIssueReporter(NameOrIdIssueFieldValue reporter)

Sets Issue reporter with user account Id

Parameters:

• NameOrIdIssueFieldValue reporter

void setIssueType(NameOrIdIssueFieldValue issueType)

Sets the JIRA issue type Name or ID

Parameters:

• NameOrIdIssueFieldValue issueType

void setLabels(List<String>labels)

Sets Issue labels

Parameters:

• List<String> labels

void setPriority(NameOrIdIssueFieldValue priority)

Sets the Issue priority

Parameters:

• NameOrIdIssueFieldValue priority

void setProject(KeyOrIdIssueFieldValue project)

Sets the JIRA project key or ID

Parameters:

• KeyOrIdIssueFieldValue project

void setReporter(NameIssueFieldValue reporter)

Sets Issue reporter with user name. Deprecated, If it is being used accountId for reporter representation use setIssueReporter instead

Parameters:

• NameIssueFieldValue reporter

void setSummary(String summary)

Sets Issue summary

Parameters:

• String summary

ZCBeans.IssueUpsertResult

The result of create or update Issue operation returned by a ZC API method

Methods:

Id getEntityId()

Returns the Id of the Salesforce Object referenced by this Result

Return Value:
Id EntityId

List<String> getErrorMessages()

Returns create or update Issue error messages. An error message prevents the Issue from being created or updated

Return Value:
List<String> ErrorMessages

String getIssueId()

Returns the Issue ID for the Issue created or updated

Return Value:
IssueId

String getIssueKey()

Returns the Issue Key for the Issue created or updated

Return Value:
String IssueKey

List<String> getWarningMessages()

Returns create or update Issue warning messages. A warning message does not prevent the Issue to be created or updated

Return Value:
List<String> WarningMessages

Boolean hasError()

Returns true if there is at least one error message

Return Value:
Boolean

Boolean hasWarnings()

Returns true if there is at least one warning message

Return Value:
Boolean

IssueUpsertResult(IssueTemplate referencedTemplate)

void setErrorMessages(List<String>errorMessages)

void setWarningMessages(List<String>warningMessages)

ZCBeans.KeyIssueFieldValue

Issue field value represented by Key attribute

Methods:

String getKey()

Returns key

Return Value:
String key

KeyIssueFieldValue(String key)

Constructor for object that represents a Jira field of type key.

void setKey(String key)

Sets key value

Parameters:

• String key

override String toString()

returns the representation of the field in String

Return Value:
the string representation.

ZCBeans.KeyOrIdIssueFieldValue

Methods:

String toString()

ZCBeans.NameIssueFieldValue

Issue field value represented by Name attribute

Methods:

String getName()

Returns name

Return Value:
String name

NameIssueFieldValue(String name)

void setName(String name)

Sets name value

Parameters:

• String name

override String toString()

returns the representation of the field in String

Return Value:
the string representation.

ZCBeans.NameOrIdIssueFieldValue

Methods:

String toString()

ZCBeans.SalesforceAttachment

The Salesforce Attachment used as input by a ZC API method

Methods:

SalesforceAttachment(Id salesforceFileID, String issueKey)

ZCBeans.TransitionIssueBean

A transition to be executed

Methods:

String getComment()

Returns Transition comment

Return Value:
String Comment

Object getFieldById(String fieldId)

Get field object by Id.

Return Value:
Object Field Value

Object getFieldByName(String fieldName)

Get field object by name.

Return Value:
Object Transition Field value

Map<String, Object> getFieldDataByName(String fieldName)

Retrieves a Transition screen field metadata (type, allowed values, required)

Return Value:
Map<String, Object> Field Metadata by Name

Map<String, Object> getFields()

Returns Transition screen fields

Return Value:
Map<String, Object> fields

List<String> getFieldsNames()

Retrieves the Transition screen field names (requires transition metadata)

Return Value:
List<String> Fields Names

List<String> getRequiredFieldsNames()

Retrieves the Transition screen required field names (requires transition metadata)

Return Value:
List<String> Required Fields Names

Integer getTransitionId()

Returns Transition Id

Return Value:
Integer Id

void populateFieldsWith(IssueTemplate issueTemplate)

Populates transition screen fields from an issue template.

void setComment(String comment)

Sets Transition comment

void setFieldById(String fieldId, Object fieldValue)

Sets Transition screen field value by id.

void setFieldByName(String fieldName, Object fieldValue)

Sets Transition screen field value by name(requires transition metadata)

String toJSON()

returns a JSON compatible with JIRA REST API request.

Return Value:
Issue Transition request as JSON

TransitionIssueBean(Integer transitionId)

Constructor receives Transition Id. Use this constructor when you do not have the metadata of the transition. Please note, you can not use validateAndSanitize if you build the bean this way.

Return Value:
TransitionIssueBean without transitions metadata available

String validateAndSanitize()

Validates if the TransitionBean has all required fields set and remove all fields that do not exist in metadata; If any required field is not set it will return a warning message (requires transition metadata)

Return Value:
Warning Message

ZCBeans.TransitionIssueResult

The result of executing a transition.

Methods:

String getErrorMessage()

Returns Error Message

Return Value:
String Error Message

String getIssueKey()

Returns Issue Key

Return Value:
String Issue Key

Boolean hasError()

Returns true if there was an error performing the transition.

TransitionIssueResult(String issueKey, String errorMessage)

Constructor, it builds the result bean.