Organization Service

Use this REST Interface to perform all operations related to the organization or the account object. This REST Interface is used for all organization operations, including insert, query, update, and delete operations to maintain organization information.

Organization Service Operations

For a list of the operations associated with this REST Interface, see the following table.

Name	Description
createOrganization	Creates an organization record.
getOrganization	Retrieves organization records, based on a user query.
deleteOrganization	Deletes an organization record.
updateOrganization	Updates an existing organization record.

The UCM REST Interface for Organization Service invokes the same workflow process used by UCM Organization Web Service, so it requires as input the same instance of SwiOrganizationIO integration object. Refer to the Organization Web Services section of this guide for detail description of this integration object.

Workflow Processes invoked by Organization Service:

Name	Workflow Process Name
createOrganization	UCM Organization Customer Profile Integration SOAP Process
getOrganization	UCM Organization Customer Profile Integration SOAP Query Process
deleteOrganization	UCM Organization Customer Profile Integration SOAP Process
updateOrganization	UCM Organization Customer Profile Integration SOAP Process

Sample Request – createOrganization

HTTP POST Request URL:

http://<Server Name>:<port>/Siebel/v1.0/workflow/UCM Organization Customer Profile Integration SOAP Process

Sample Request body in JSON format:

{
    "RealtimePubSub": "true",				//Override WF Proc Prop
    "SwiOrganizationIO": {					//Organization IO
        "IntObjectFormat": "Siebel Hierarchical",
        "MessageId": "",
        "IntObjectName": "SwiOrganizationIO",
        "MessageType": "Integration Object",
        "ListOfSwiOrganizationIO": {
            "ExternalSystemId": "Siebel01",
            "Account": {
                "operation": "Insert",			//Insert operation 
                "Id": "SBL01_ABC_ACCT_0111",
                "Location": "0111",
                "Main Fax Number": "1111111111",
                "Main Phone Number": "1111111111",
                "Name": "ABC ACCOUNT",
                "ListOfAccount_Business Address": {
                    "Account_Business Address": {
                        "IsPrimaryMVG": "Y",
                        "Address Id": "SBL01_BUS_ADDR_0002",
                        "City": "San Francisco",
                        "Country": "USA",
                        "Postal Code": "94104",
                        "State": "CA",
                        "Street Address": "222 Pine St"
                    }
                }
            }
        }
    }
}

Sample Request body in XML format:

<?xml version="1.0" ?>
<request>
    <RealtimePubSub>true</RealtimePubSub>		//Override WF Proc Prop
    <SwiOrganizationIO					//Organization IO
        IntObjectFormat="Siebel Hierarchical"
        MessageId=""
        IntObjectName="SwiOrganizationIO"
        MessageType="Integration Object">
        <ListOfSwiOrganizationIO ExternalSystemId="Siebel01">
            <Account operation="Insert">			//Insert operation
                <Id>SBL01_ABC_ACCT_0111</Id>
                <Location>0111</Location>
                <Name>ABC Account</Name>
                <Main_spcPhone_spcNumber>1111111111</Main_spcPhone_spcNumber>
            </Account>
        </ListOfSwiOrganizationIO>
    </SwiOrganizationIO>
</request>