OrgResourceService
The OrgResourceService contains functions used to manage resources, such as creating, deleting, finding, and updating resources.
The table below lists the functions available from the OrgResourceService.
| Function | Description | Results |
|---|---|---|
| archivedResources | Retrieves archive records of resources that have been deleted.
When resources are deleted, an archive of their records are maintained in order to allow process and work-item administration to be completed. This service allows those archive records to be retrieved. The results can be paged, or the entire result set can be returned in one call. System action required: resolveResource |
GetDeletedResourcesResponseType |
| createResource | Creates one or more resources, which causes a GUID to be assigned to each resource, and allows the resources to log into ActiveMatrix BPM applications.
Typically, you will use the listCandidateResources function to get a list of candidate resources in a particular LDAP container, then use this function to create the desired resources from those candidates. Once you have created resources, they can be mapped to the desired groups or positions using the updateResource function (see below). If the request identifies a resource that is already created, the already-present attribute in the response is set to "false". System action required: resourceAdmin or createResourceAdmin |
CreateResourceResponseType |
| deleteResource | Deletes one or more resources and their associated organization mappings (if any).
System action required: resourceAdmin or deleteResourceAdmin |
DeleteResourceResponseType |
| findByEntity | Finds all resources associated with one or more specified organization model entities.
Note: This function cannot be used to perform a user lookup using an LDAP DN. To do that, use the
findByDN function.
Also see the findByName function (below). System action required: resolveResource |
FindResourcesResponseType |
| findByName | Finds all resources associated with one or more specified names.
Also see the findByEntity function (above). System action required: resolveResource |
FindResourcesResponseType |
| getResource | Returns details about one or more specified resources, such as positions and groups in which the resource is a member, privileges and capabilities held by the resource, the LDAP entry from which the resource is derived, and so on.
System action required: resolveResource |
GetResourceResponseType |
| purgeDeletedResources | Permanently deletes the archived resource records. The function allows selected records to be purged, or all records to be purged. The response states how many records were purged.
When resources are deleted, a summary of their records are maintained in order to allow process and work-item administration to be completed. This function causes those deletion records to be permanently purged. After being purged, the user is still a candidate resource, and can be created again (assuming the user is still in the LDAP source). System action required: resourceAdmin or deleteResourceAdmin |
PurgeDeletedResourcesResponseType |
| updateResource | Updates the given properties of the specified resource or resources. This allows you to add or remove a resource's privileges, capabilities, and resource attributes, and so on. You can also add or remove a resource from positions and groups with this function.
Only the properties passed in the request are updated; those not passed in the request are left unchanged. Multiple resources can be updated in one request, using a separate <resource> element for each. System action required: resourceAdmin or createResourceAdmin |
UpdateResourceResponseType |