OrganizationApi class

Public REST API for Jira Service Management

Constructors

OrganizationApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addOrganization({required String serviceDeskId, required OrganizationServiceDeskUpdateDTO body}) → Future<void>

This method adds an organization to a service desk. If the organization ID is already associated with the service desk, no change is made and the resource returns a 204 success code.

addUsersToOrganization({required int organizationId, required UsersOrganizationUpdateDTO body}) → Future<void>

This method adds users to an organization.

createOrganization({required OrganizationCreateDTO body}) → Future<OrganizationDTO>

This method creates an organization by passing the name of the organization.

deleteOrganization(int organizationId) → Future<void>

This method deletes an organization. Note that the organization is deleted regardless of other associations it may have. For example, associations with service desks.

deleteProperty({required String organizationId, required String propertyKey}) → Future<void>

Removes a property from an organization.

getOrganization(int organizationId) → Future<OrganizationDTO>

This method returns details of an organization. Use this method to get organization details whenever your application component is passed an organization ID but needs to display other organization details.

getOrganizations({int? start, int? limit, String? accountId}) → Future<PagedDTOOrganizationDTO>

This method returns a list of organizations in the Jira Service Management instance. Use this method when you want to present a list of organizations or want to locate an organization by name.

getOrganizations2({required String serviceDeskId, int? start, int? limit, String? accountId}) → Future<PagedDTOOrganizationDTO>

This method returns a list of all organizations associated with a service desk.

getPropertiesKeys(String organizationId) → Future<PropertyKeys>

Returns the keys of all properties for an organization. Use this resource when you need to find out what additional properties items have been added to an organization.

getProperty({required String organizationId, required String propertyKey}) → Future<EntityProperty>

Returns the value of a property from an organization. Use this method to obtain the JSON content for an organization's property.

getUsersInOrganization({required int organizationId, int? start, int? limit}) → Future<PagedDTOUserDTO>

This method returns all the users associated with an organization. Use this method where you want to provide a list of users for an organization or determine if a user is associated with an organization.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeOrganization({required String serviceDeskId, required OrganizationServiceDeskUpdateDTO body}) → Future<void>

This method removes an organization from a service desk. If the organization ID does not match an organization associated with the service desk, no change is made and the resource returns a 204 success code.

removeUsersFromOrganization({required int organizationId, required UsersOrganizationUpdateDTO body}) → Future<void>

This method removes users from an organization.

setProperty({required String organizationId, required String propertyKey}) → Future

Sets the value of a property for an organization. Use this resource to store custom data against an organization.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited