Organization create request

Description

Creates an Organization with specified details. It performs all the steps required to create entries in core company forms and onboard the organization so that it is usable through BMC Cloud Lifecycle Management without any manual step. Creates FoundationCostCenter and FoundationLocation records as well if they are passed as part of the Organization parameter.

BMC recommends that you delete the custom provider and use the out-of-the-box API/provider when you upgrade to version 4.6.

API stability classification

Unassigned

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/Organization/create

Organization

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP request and response headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects 

Name

Type

Multi-
plicity

Description

callbackURL

String

0..1

URL to call when the operation finishes

postCallout

String

0..1

Identifier of a callout to run after the operation executes

preCallout

String

0..1

Identifier of a callout to run before the operation executes

timeout

Integer

0..1

Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds

operationParams

OperationParameter

1

Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing input parameters with an API request.

 
Input parameters to include in operationParams 

Name

Type

Multi-
plicity

Description

additionalInfo

NameValuePair

0..*

Additional information about organization, specify in key value format. Internal business logic will not use these key-value pairs, however callouts can make use of these.

isRemote

boolean

0..1

Reserved. This parameter should not be passed or pass 'false' value.

organization

Organization

1

Organization object with all the required attributes. Minimum expected is name attribute, that's it. Creates FoundationCostCenter and FoundationLocation records as well if they are passed as part of Organization parameter.

HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a Task object.

Example

You must perform the following operations before you execute this request.

  1. Create a provider definition.
  2. Create a provider.

Use the value of providerURI that points to the Generic Adapter - Generic Provider URI in the following HTTP request to create an organization:

{
  "timeout" : 1000000,
  "callbackURL" : "",
  "postCallout" : "",
  "operationParams" : [ {
    "name" : "organization",
    "value" : {
      "cloudClass" : "com.bmc.cloud.model.beans.Organization",      
      "description" : "created via rest-update-update",     
      "foundationLocationsObject" : [ {
        "cloudClass" : "com.bmc.cloud.model.beans.FoundationLocation",
        "customFieldsObject" : [ {
          "cloudClass" : "com.bmc.cloud.model.beans.CustomField",
          "description" : "Country",
          "name" : "sit_site.1000000002",
          "stringValue" : "$<CountryName>$",
          "type" : "String"
        }, {
          "cloudClass" : "com.bmc.cloud.model.beans.CustomField",
          "description" : "StateProvince",
           "name" : "sit_site.1000000003",
          "stringValue" : "$<StateName>$",
          "type" : "String"
        }, {
          "cloudClass" : "com.bmc.cloud.model.beans.CustomField",
          "description" : "City",
          "name" : "sit_site.1000000004",
          "stringValue" : "$<CityName>$",
          "type" : "String"
        } ],
         "name" : "$<TenantLocationName>$"
      } ],
         "name" : "$<TenantName>$",
      "parentOrganizationObject" : {
        "cloudClass" : "com.bmc.cloud.model.beans.Organization",
         "name" : "$<TenantName>$"
      }
    },
    "type" : "com.bmc.cloud.model.beans.Organization",
    "multiplicity" : "1"
  },{
		"name" : "isRemote", 
		"value" : true, 
		"type" : "java.lang.Boolean", 
		"multiplicity" : "0..1"
                                }],
  "preCallout" : ""
}


Was this page helpful? Yes No Submitting... Thank you

Comments