Organization class

The Organization class represents business organizations, including units that are part of larger organizations.

Organization class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the Organization class.

Basic APIs

Name	HTTP method	URI	Description
create	POST	csm/Organization	Creates a Organization object.
get	GET	csm/Organization/guid	Retrieves a Organization object.
update	POST	csm/Organization/guid	Updates a Organization object.
search	POST	csm/Organization/search	Searches for Organization objects.

Operation APIs

Name	HTTP method	URI	Description
getQuota	POST	csm/Organization/guid/getQuota	Transfers the ownership from existing user to the new user
getQuotaUsage	POST	csm/Organization/guid/getQuotaUsage	Transfers the ownership from existing user to the new user
updateQuota	POST	csm/Organization/updateQuota	Transfers the ownership from existing user to the new user
validateQuota	POST	csm/Organization/guid/validateQuota	This API validates quota for the Tenant. The validation is done across the requested services vs the quota added earlier.

Relationship APIs

Name	HTTP method	URI	Description
relation	GET	csm/Organization/guid/assignedContainers	Retrieves the assignedContainers relationship. Note: This API is deprecated. Instead, use the following API from this LogicalHostingEnvironment class. csm/Organization/guid/logicalHostingEnvironment - To list all associated LogicalHostingEnviroments.
relation	GET	csm/Organization/guid/childOrganizations	Retrieves the childOrganizations relationship.
relation	GET	csm/Organization/guid/computeResource	Retrieves the computeResource relationship.
relation	GET	csm/Organization/guid/entitlementPackages	Retrieves the entitlementPackages relationship.
relation	GET	csm/Organization/guid/functionalComponent	Retrieves the functionalComponent relationship.
relation	GET	csm/Organization/guid/generatedTickets	Retrieves the generatedTickets relationship.
relation	GET	csm/Organization/guid/logicalHostingEnvironment	Retrieves the logicalHostingEnvironment relationship.
relation	GET	csm/Organization/guid/parentOrganization	Retrieves the parentOrganization relationship.
relation	GET	csm/Organization/guid/resourceSet	Retrieves the resourceSet relationship.
relation	GET	csm/Organization/guid/serviceOfferingInstance	Retrieves the serviceOfferingInstance relationship.
relation	GET	csm/Organization/guid/storageConnection	Retrieves the storageConnection relationship.
relation	GET	csm/Organization/guid/storageResource	Retrieves the storageResource relationship.
relation	GET	csm/Organization/guid/supplierContracts	Retrieves the supplierContracts relationship.
relation	GET	csm/Organization/guid/tenantContracts	Retrieves the tenantContracts relationship.
relation	GET	csm/Organization/guid/ticketTemplateMaps	Retrieves the ticketTemplateMaps relationship.
relation	GET	csm/Organization/guid/ticketTemplates	Retrieves the ticketTemplates relationship.
relation	GET	csm/Organization/guid/tickets	Retrieves the tickets relationship.
relation	GET	csm/Organization/guid/provider	Retrieves the provider relationship.
relation	GET	csm/Organization/guid/tags	Retrieves the tags relationship.

Organization class relationships and attributes

The following tables list the relationships and attributes of the Organization class.

Relationships

Name	Type	Multi- plicity	Description
assignedContainers	NetworkContainer	0..*	Containers assigned to the organization
childOrganizations	Organization	0..*	An organization may have multiple "child" organizations, or organizations one level lower in the organization hierarchy.
computeResource	ComputeResource	0..*	Compute resources deployed for the organization
entitlementPackages	EntitlementPackage	0..*	Retrieves entitlement packages that this tenant is associated with.
functionalComponent	FunctionalComponent	0..*	Functional components deployed for the organization
generatedTickets	Ticket	0..*
logicalHostingEnvironment	LogicalHostingEnvironment	0..*	Associated logical hosting environments
parentOrganization	Organization	0..1	An organization may have one "parent" organization, or an organization one level higher in the organization hierarchy.
resourceSet	ResourceSet	0..*	Resource sets deployed for the organization
serviceOfferingInstance	ServiceOfferingInstance	0..*	Service offering instances deployed for the organization
storageConnection	StorageConnection	0..*	Storage connections deployed for the organization
storageResource	StorageResource	0..*	Storage resources deployed for the organization
supplierContracts	Contract	0..*	Supplier contracts associated with the organization
tenantContracts	Contract	0..*	Tenant contracts associated with the organization
ticketTemplateMaps	TicketTemplateMap	0..*
ticketTemplates	TicketTemplate	0..*
tickets	Ticket	0..*
cloudClass	CloudClass	1	Fully-qualified name of the class to which the object belongs
provider	Provider	1	Provider that created the object
tags	Tag	0..*	Tags associated with the object

Attributes

Name	Type	Multi- plicity	Description
costCenters	FoundationCostCenter	0..*
customFields	CustomField	0..*
locations	FoundationLocation	0..*
isOnboarded	Boolean	1	Indicates whether the object is onboarded
externalID	String	0..1	Identifier used for the object by an external provider
owner	String	0..1	Name of the owner of the object
reconciliationID	String	0..1	Reconciliation identity value for the object from the BMC Atrium CMDB
tokenID	String	0..1	Token identifier
description	String	0..1	Text that describes the object
guid	String	1	Globally unique identifier for the object
labels	String	0..*
modifiedDate	Date	0..1	Date the Cloudobject was modified
name	String	1	Human-readable name of the object