Edit Schedules

The edit schedule operation allows you to edit the reskill schedule of resources.

HTTPS Method

PATCH

URI

https://<server>/adminapi/csq/{id}/schedules

Example URI

https://uccx-server/adminapi/csq/{id}/schedules

Query Parameter

onNoImpact

Content TypeApplication/XML, Application/JSON
HTTPS Success Code

200

HTTPS Failure Codes

207,400,401,403,404,405,409,424,500,503

Error Codes

—

Sample Input XML—Edit Schedules (PATCH)

<schedules>
    <schedule id="1">
        <resource id="Michael">
            <removeAt>Modified auto removal time for this resource to be removed from CSQ</removeAt>
        </resource>    
    </schedule>    
 </schedules>

Output Response

The edit schedule API will have one of the following output responses:

  • Success

  • Partial Success

  • Failure

Success Response

HTTPS/1.1 200 OK

Partial Success Response

The following partial success response when query parameter onNoImpact is sent and if there is any impact on a resource:

HTTPS status code 207 Multi-Status

Sample Output XML—Edit Schedules (PATCH)

<?xml version="1.0" encoding="UTF-8"?>
     <schedules>
       <schedule id="1">
            <resource id="steve">
                <status>impact</status>
                <impacts>
                    <impact type="AUTO_ADD_UPDATE">
                        <addAt>1525061950</addAt>
                        <csqs>csq1,csq2</csqs>
                    </impact>
                </impacts>
            </resource>
        </schedule>
        <schedule id="2">    
            <resource id="Jefferson">
                <status>impact</status>
                <impacts>
                    <impact type="AUTO_REMOVE_UPDATE">
                    <removeAt>1525061952</removeAt>
                    <csqs>csq1,csq2</csqs>
                    </impact>
                </impacts>
            </resource>
        </schedule>  
        <schedule id="3">  
            <resource id="Michael">
                <status>Success</status>
            </resource>
        </schedule>    
      </schedules>

Failure Response

Sample Output XML—Edit Schedules (PATCH)

<?xml version="1.0" encoding="UTF-8"?>
<apiErrors>
    <apiError>
        <errorData></errorData>
        <errorMessage>Resource(s) not found in the system.</errorMessage>
        <errorType>InstanceNotFound</errorType>
        <i18n>
            <key>adminapi.resources.notfound</key>
            <args/>
        </i18n>
    </apiError>
</apiErrors>