{"type":"api","title":"Rescheduling a Job","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/c185c5e2-e05d-3be1-ba09-4260128bc6c1","info":{"title":"Job Scheduler APIs","description":"APIs exposed by Inventory service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/inventory-job-scheduler-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/rs/json/jobSchedulerServiceInv/v1/","description":"Generated server url"}]},"spec":{"tags":["Job Scheduler"],"summary":"Rescheduling a Job","description":"This API is used to reschedule a particular Inventory Job with specified timings and other metadata.","operationId":"reScheduleJob","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"JobDto","properties":{"jobType":{"type":"string","description":"Specifies the job type. Always \"Inventory\""},"jobName":{"type":"string","description":"Indicates name of Job - Switch inventory, Internal Schedule, Failed Feature Sync"},"description":{"type":"string","description":"description"},"jobSchedule":{"description":"Indicates schedule of the job to be executed","type":"object","properties":{"now":{"type":"boolean","description":"Indicates if the job should execute immediately when set to true."},"daily":{"type":"boolean","description":"Indicates if the job should execute daily when set to true."},"weekly":{"type":"boolean","description":"Indicates if the job should execute weekly when set to true."},"fortnight":{"type":"boolean","description":"Indicates if the job should execute fortnight when set to true."},"monthly":{"type":"boolean","description":"Indicates if the job should execute monthly when set to true."},"yearly":{"type":"boolean","description":"Indicates if the job should execute yearly when set to true."},"minute":{"type":"boolean","description":"Indicates if the job should execute every minute when set to true."},"hourly":{"type":"boolean","description":"Indicates if the job should execute every hour when set to true."},"hourRepetition":{"type":"string","description":"Indicates the hour repetition for job."},"dayRepetition":{"type":"string","description":"Indicates the day repetition for job."},"noOfRepetitions":{"type":"string","description":"Indicates the number of repetition for job."},"dayOfWeek":{"type":"string","description":"dayOfWeek"},"jobScheduleTime":{"description":"jobScheduleTime","type":"object","properties":{"hour":{"type":"string","description":"Specificy the hour to start the job"},"minute":{"type":"string","description":"Specificy the minute to start the job"},"startDate":{"type":"string","description":"Specificy the startDate to start the job"},"endDate":{"type":"string","description":"Specificy the endDate to start the job"},"day":{"type":"string","description":"Specificy the day to start the job"},"month":{"type":"string","description":"Specificy the month to start the job"},"year":{"type":"string","description":"Specificy the year to start the job"}},"xml":{"name":"JobTimeDto"},"$$ref":"#/components/schemas/JobTimeDto"},"monthlyDay":{"type":"string","description":"monthlyDay"},"monthlyMonth":{"type":"string","description":"monthlyMonth"},"monthlyWeek":{"type":"string","description":"monthlyWeek"},"monthlyWeekDay":{"type":"string","description":"monthlyWeekDay"}},"xml":{"name":"JobScheduleDto"},"$$ref":"#/components/schemas/JobScheduleDto"},"jobSpecification":{"description":"jobSpecification","type":"object","properties":{"taskSpecification":{"description":"taskSpecification","type":"object","properties":{"taskName":{"type":"string","description":"taskName"},"domainSpecId":{"type":"string","description":"domainSpecId"}},"$$ref":"#/components/schemas/TaskElementSpecificationDto"},"runTaskInParallel":{"type":"boolean","description":"runTaskInSequence"},"runTaskInSequence":{"type":"boolean","description":"runTaskInSequence"}},"$$ref":"#/components/schemas/JobSpecificationDto"},"userName":{"type":"string","description":"Specifies the username"}},"xml":{"name":"JobDto"},"$$ref":"#/components/schemas/JobDto"},"example":{"jobSchedule":{"daily":true,"monthly":false,"now":false,"weekly":false,"minute":false,"yearly":false,"fortnight":false,"hourly":false,"hourRepetition":"null","dayRepetition":"1","noOfRepetitions":"0","monthlyDay":"null","monthlyMonth":"null","monthlyWeek":"null","monthlyWeekDay":"null","dayOfWeek":"null","jobScheduleTime":{"hour":"1","minute":"00","startDate":"08/11/2022, 10:11 AM","endDate":"undefined"}},"jobSpecification":{"taskSpecification":{"domainSpecId":"100"}},"jobType":"Inventory","jobName":"Switch Inventory","userName":"SYSTEM","description":"undefined"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"__originalOperationId":"reScheduleJob","method":"post","path":"/reScheduleJob"}}