The OrganizationDataService provides operations to manage organization. The OrganizationDataService can also be used to manage related entities such as Departments, Divisions, Agencies, Partners, and Afffiliates. Each of these is viewed as a type of Organization record.
The operations below can be found on the OrganizationDataSerivce.
OrganizationDataService Operations
|
Endpoint address: |
Service Operations
Operation Name: search(String name, String type, String classification, String internalOrgId)
Parameters:
- String name: Name of the Organization. To search on partial matches, add a wildcard. For example: Op% will provide a list of all organizations that start with "Op"
- String type: Type of Organization
- String classification: Classification of the Organization a list of Classifications is provided above
- String internalOrgId: Organizationid that is used by the company. This is not the system generated OrgId maintained within OpenIAM.
Return:
- List of Organizations
The search operation allows you for an Organization using any combination of the parameters above.
Sample Request:
To search based on an Organization Name with a wild card:
To search based on an Intenal Organization Id:
Sample Response: