Batch-Config



[tags: RPPD]

Resource Root

https://localhost:8443/api/rest/batch-config

Summary


Resources Methods
https://localhost:8443/api/rest/batch-config
https://localhost:8443/api/rest/batch-config/{component}

 GET Retrieves the current batch configuration status.

PUT Update a batch of server's configuration by the specified component.

Resources


https://localhost:8443/api/rest/batch-config


https://localhost:8443/api/rest/batch-config/{component}


Template Parameters

Name Type Description
component xs:string The component which you want to do batch configuration

Methods

GET

Retrieves the current batch configuration status

Response

Status Representation Description
200 application/vnd.plcm.plcm-batch-config+json
application/vnd.plcm.plcm-batch-config+xml
 Retrieval of batch configuration was successful
304 Batch configuration has not changed.
401 application/vnd.plcm.plcm-error+json
 Invalid credentials.
403 application/vnd.plcm.plcm-error+json
 Unable to get permission. Retrieving batch config requires administrator role.
500 application/vnd.plcm.plcm-error+json
 An internal error occurred while attempting to get the current batch configuration status.

PUT

Update a batch of server's configuration by the specified component

Request

Representations

application/vnd.plcm.plcm-batch-config+json
application/vnd.plcm.plcm-batch-config+xml

Response

Status Representation Description
204 Batch settings were applied successfully
401 application/vnd.plcm.plcm-error+json
 Invalid credentials.
403 application/vnd.plcm.plcm-error+json
 Unable to get permission. Retrieving time config requires administrator role.
500 application/vnd.plcm.plcm-error+json
 An internal error occurred while attempting to apply the given time setttings.