UserBatchOperation



[tags: RPRM_INTERNAL]

Resource Root

https://localhost:8443/api/rest/user-batch-operation

Summary


Resources Methods
https://localhost:8443/api/rest/user-batch-operation

https://localhost:8443/api/rest/user-batch-operation/users

DELETE Delete users.

GET  [tags: RPRM] .

https://localhost:8443/api/rest/user-batch-operation/orphan-ad-users

DELETE  [tags: RPRM] .

https://localhost:8443/api/rest/user-batch-operation/bulk-users

DELETE  [tags: RPRM] .

POST  [tags: RPRM] .

https://localhost:8443/api/rest/user-batch-operation/h323-alias

GET  [tags: RPRM] .

POST  [tags: RPRM] .

https://localhost:8443/api/rest/user-batch-operation/sip-alias

GET  [tags: RPRM] .

POST  [tags: RPRM] .

https://localhost:8443/api/rest/user-batch-operation/user-status

POST batch update users' status.

Resources


https://localhost:8443/api/rest/user-batch-operation


https://localhost:8443/api/rest/user-batch-operation/users


Methods

DELETE

Delete users. Input param is user UUID list.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-string-list+xml
application/vnd.plcm.plcm-string-list+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-map-item-list+xml
application/vnd.plcm.plcm-map-item-list+json
Delete users successfully.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

GET


[tags: RPRM]

Request

Query Parameters

Name Type Description
search-string xs:string
search-type xs:string
tenant-id xs:string
limit xs:int
Limit the number of users returned to this number, even if more users match the query.
Note 1: The valid integer range is 1 to 2147483647.
Note 2: If the limit value is less than or equal to zero, the system will ignore the limit request and return all results.
Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found".
This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status Representation Description
200 application/vnd.plcm.plcm-user-list+xml
application/vnd.plcm.plcm-user-list+json
User information successfully retrieved
304
User information has not changed since the last search.

Note: The API client must provide the "plcm-user-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-user-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
users on the server.
400 application/vnd.plcm.plcm-error+xml
The requested search result limit of is too large. User roles required: administrator, provisioner.

https://localhost:8443/api/rest/user-batch-operation/orphan-ad-users


Methods

DELETE


[tags: RPRM]

Response

Status Representation Description
204 Successfully deleted
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
409 application/vnd.plcm.plcm-error+xml
User UUID is required.
409 application/vnd.plcm.plcm-error+xml
User token is null.

https://localhost:8443/api/rest/user-batch-operation/bulk-users


Methods

DELETE


[tags: RPRM]

Request

Query Parameters

Name Type Description
file-path-name xs:string

Response

Status Representation Description
204 Successfully operated.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
409 application/vnd.plcm.plcm-error+xml
No directory information is allowed in file name.
409 application/vnd.plcm.plcm-error+xml
Delete file failure.

POST


[tags: RPRM]

Request

Query Parameters

Name Type Description
file-path-name xs:string
area-id xs:string

Response

Status Representation Description
204 Successfully operated.
400 text/plain
Bad request. File Path Name is not null, Area Id is integer
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.
409 application/vnd.plcm.plcm-error+xml
User Process Bulk Upload Exception.

https://localhost:8443/api/rest/user-batch-operation/h323-alias


Methods

GET


[tags: RPRM]

Response

Status Representation Description
200 application/vnd.plcm.plcm-string+xml
application/vnd.plcm.plcm-string+json
Successfully operated.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

POST


[tags: RPRM]

Request

Query Parameters

Name Type Description
file-path-name xs:string

Response

Status Representation Description
200 application/vnd.plcm.plcm-map-item-list+xml
application/vnd.plcm.plcm-map-item-list+json
Successfully operated.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

https://localhost:8443/api/rest/user-batch-operation/sip-alias


Methods

GET


[tags: RPRM]

Response

Status Representation Description
200 application/vnd.plcm.plcm-string+xml
application/vnd.plcm.plcm-string+json
Successfully operated.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

POST


[tags: RPRM]

Request

Query Parameters

Name Type Description
file-path-name xs:string

Response

Status Representation Description
200 application/vnd.plcm.plcm-map-item-list+xml
application/vnd.plcm.plcm-map-item-list+json
Successfully operated.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

https://localhost:8443/api/rest/user-batch-operation/user-status


Methods

POST

batch update users' status.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-string-list+xml
application/vnd.plcm.plcm-string-list+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-map-item-list+xml
application/vnd.plcm.plcm-map-item-list+json
Batch update users' status successfully.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.