Create Schedules

The create schedules operation saves the schedules of agents that are yet to be added or removed for a CSQ.

HTTPS Method

POST

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—Create Schedules

<schedules>
   <schedule>
      <resource id="A1">
         <addAt>The auto addition time for this resource to be added to CSQ</addAt>
         <removeAt>The auto removal time for this resource to be removed from CSQ</removeAt>
      </resource>
   </schedule>
   <schedule>
      <resource id="A2">
         <addAt>The auto addition time for this resource to be added to CSQ</addAt>
         <removeAt>The auto removal time for this resource to be removed from CSQ</removeAt>
      </resource>
   </schedule>
</schedules>

Output Response

The create schedules 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 is displayed when query parameter onNoImpact is sent and if there is any impact on a resource:

HTTPS status code 207 Multi-Status.

Sample Output XML—Create Schedules

<schedules>
   <schedule id="1">
       <resource id="A1">
         <addAt>The auto addition time for this resource to be added to CSQ</addAt>
         <removeAt>The auto removal time for this resource to be removed from CSQ</removeAt>
      </resource>
   </schedule>
   <schedule>
      <resource id="A2">
         <status>impact</status>
         <impacts>
            <impact type="AUTO_REMOVE_UPDATE">
               <removeAt>1525061952</removeAt>
               <csqs>csq1, csq2</csqs>
            </impact>
         </impacts>
      </resource>
   </schedule>
  </schedules>

Failure Response

Sample Output XML—Create Schedules 

<apiErrors>
  <apiError>
    <errorData>InternalServerError</errorData>
    <errorMessage>Message</errorMessage>
    <errorType>InternalServerError</errorType>
    <i18n>
      <key>adminapi.internal.error</key>
    </i18n>
  </apiError>
</apiErrors>