[Index]

API Reference for view/ReSyncLdapUsersVIEW

This view is used to select one or more LDAP users and force the sync and update workflows.

Model ref.: view/ReSyncLdapUsersVIEW

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/view/ReSyncLdapUsersVIEW/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "description": {
               "title": "Description",
               "default": "LDAP User Re-Sync Tool",
               "displayable": true,
               "readonly": true,
               "type": "string"
          },
          "notes": {
               "title": "Notes",
               "default": "This feature will re-sync a LDAP user and force an update on all UC Apps. Please select the LDAP server and one or more LDAP users to re-sync.",
               "displayable": true,
               "readonly": true,
               "type": "string"
          },
          "ldap_server_bkey": {
               "target": "/api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "format": "uri",
               "title": "LDAP Server",
               "type": "string",
               "description": "LDAP Server to Sync from.",
               "target_model_type": "data/Ldap",
               "choices": []
          },
          "ldap_server_pkid": {
               "readonly": true,
               "type": "string",
               "description": "PKID of the LDAP server.",
               "title": "LDAP Server PKID"
          },
          "ldap_users": {
               "items": {
                    "type": "string"
               },
               "type": "array",
               "description": "Select LDAP Users to ReSync.",
               "title": "LDAP Users"
          }
     }
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/ReSyncLdapUsersVIEW/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/ReSyncLdapUsersVIEW as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/view/ReSyncLdapUsersVIEW	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

The GET call to

tool/Transaction/[trans pkid]

shows the View resource has no instance pkid, because a view model stores no instances.

Task	Call	URL	Parameters	Response
Tag	PATCH	/api/view/ReSyncLdapUsersVIEW/+tag/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Get the on-line Help for view/ReSyncLdapUsersVIEW.	GET	/api/view/ReSyncLdapUsersVIEW/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/ReSyncLdapUsersVIEW as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Tag	PATCH	/api/view/ReSyncLdapUsersVIEW/[pkid]/+tag	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Help	GET	/api/view/ReSyncLdapUsersVIEW/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for view/ReSyncLdapUsersVIEW.

API Reference for view/ReSyncLdapUsersVIEW

GET http://[host-proxy]/api/view/ReSyncLdapUsersVIEW/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Tag

Help

Instance API Reference

Tag

Help