Skip to content

Latest commit

 

History

History
176 lines (133 loc) · 5.41 KB

Update Change Management Scheduled Task API.md

File metadata and controls

176 lines (133 loc) · 5.41 KB
Raw

Change Management Scheduled Task REST API Design

PUT /V1/CMDB/CM/Tasks/ScheduledTask

Call this API to update a Scheduled Task (ST) of an APPROVED Network Change (NC).

Note:

  • Use PUT method to update an ST that is on “Waiting” status.

  • If an ST is on “Running” or “Executed” status, update request is not allowed.

  • Follow NetBrain system user privileges

Detail Information

Title: Change Management Scheduled Task API

Version: 09/30/2019

API Server URL: http(s)://IP Address of NetBrain Web API Server/ServicesAPI/API/V1/CMDB/CM/Tasks/ScheduledTask/<runbook_id/ticket_id>

Authentication:

Type In Name
Bearer Authentication Headers Authentication token

Request body (*required)

Name Type Description
Runbook_id* string NC runbook ID
ticket_id* string 3rd party ITSM ticket ID.
execution_time* date ST start time
do_not_execute_after* date ST end time

Note: Runbook_id and ticket_id only one should be provided by customer.

Query Parameters (*required)

No parameters required.

Headers

Data Format Headers

Name Type Description
Content-Type String Support “application/json”
Accept String Support “application/json”

Authorization Headers

Name Type Description
Token String Authentication token, get from login API.

Response

Name Type Description
runbook_id String NC runbook ID
scheduler String User name of the scheduler
scheduled_task_status String Status of the created scheduled task
execution_time date ST start time
do_not_execute_after date ST end time
status String Status of scheduled task
statusCode Integer The returned status code of executing the API.
statusDescription String The explanation of the status code.

Note: Error Code clarification

Code Message
790200 Success.
791000 The runbook_id or ticket_id is required.
791006 The Change Management runbook is not found.
798808 Schedule can only be applied to approved Change Management runbook.
794011 Failed to update schedule.
794011 Task Schedule can not be found.
793001 System Exception Message.

Example:

{
    "runbook_id" : "d5c5bb3c-1aad-ae2c-a591-347ede7d71a9",
    "scheduler" : "netbrain",
    "scheduled_task_status" : "pending",
    "execution_time" : "2020/01/15",
    "do_not_execute_after" : "2020/01/16",
    "status" : "pending"
    "statusCode" : "790200",
    "statusDescription" : "Success"
}

Full Example

# import python modules 
import requests
import time
import urllib3
import pprint
#urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
import json

token = "87ccc8aa-6550-41cd-a54b-ae11b521a837" 
full_url = "http://192.168.28.139/ServicesAPI/API/V1/CM/Tasks/ScheduleTask"
headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}  
headers['token'] = token

body = {
    "Runbook_id":"453ac967-12ad-f8f1-5158-648500fa67fb",
#     "ticket_id":"562d351f1b5e44502fd68774cc4bcb51",
    "execution_time":"2020-01-17T20:06:00.000Z",
    "do_not_execute_after":"2020-01-17T21:06:00.000Z"
}

try:
    # Do the HTTP request
    response = requests.put(full_url, headers=headers, data = json.dumps(body), verify=False)
    # Check for HTTP codes other than 200
    if response.status_code == 200:
        # Decode the JSON response into a dictionary and use the data
        js = response.json()
        print (js)
    else:
        print ("Update CM task failed! - " + str(response.text))
except Exception as e:
    print (str(e))
{'statusCode': 790200, 'statusDescription': 'Success.'}

cURL Code from Postman

curl -X PUT \
  http://192.168.28.139/ServicesAPI/API/V1/CMDB/CM/Tasks/ScheduledTask \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: keep-alive' \
  -H 'Content-Length: 141' \
  -H 'Content-Type: application/json' \
  -H 'Host: 192.168.28.139' \
  -H 'Postman-Token: 13924834-e736-4274-a598-d36728cc3fa5,29c8b926-d190-4f37-baf7-ff2ca4ca3639' \
  -H 'User-Agent: PostmanRuntime/7.15.2' \
  -H 'cache-control: no-cache' \
  -H 'token: 87ccc8aa-6550-41cd-a54b-ae11b521a837' \
  -d '{
    "Runbook_id":"d5c5bb3c-1aad-ae2c-a591-347ede7d71a9",
    "execution_time":"2020/01/15",
    "do_not_execute_after":"2020/01/16"
}
'