Update Job History - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Update Job History","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Modify the specified deployment job. _Check the response section for applicable examples (if any)._**","operationId":"updateJobHistory","parameters":[{"description":"UUID of the deployment job.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : PUT /fmc_config/v1/domain/DomainUUID/deployment/jobhistories/{jobId} ( Update job note for a job. )":{"value":{"deploymentNote":"Updated note","id":"0050568B-9937-0ed3-0000-463856468766","type":"JobHistory"}}},"schema":{"type":"object","properties":{"deploymentNote":{"description":"User provided job note","type":"string"},"deviceList":{"description":"List of devices which have been part of the job.","items":{"type":"object","properties":{"canRollback":{"description":"Indicates whether the deployed version to device in the deployment job is rollback capable. This field is available only if context filter parameter has value as RollbackApplicable.","type":"boolean"},"containerName":{"description":"Name of the container. This will still be displayed after deletion.","type":"string"},"containerUUID":{"description":"UUID of the container","type":"string"},"deployedVersion":{"description":"Config version of the device in the deployment job","format":"int32","type":"integer"},"deploymentStatus":{"description":"Deployment status of the device in the deployment job","enum":["DEPLOYING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","SSP_SUCCEEDED","SSP_FAILED","SSP_PRIMARY_BOOTSTRAP_SUCCEEDED","SSP_PRIMARY_BOOTSTRAP_FAILED","SSP_SECONDARY_BOOTSTRAP_SUCCEEDED","SSP_SECONDARY_BOOTSTRAP_FAILED","PRIMARY_BOOTSTRAP_SUCCEEDED","PRIMARY_BOOTSTRAP_FAILED","SECONDARY_BOOTSTRAP_SUCCEEDED","SECONDARY_BOOTSTRAP_FAILED","BREAK_SUCCEEDED","BREAK_FAILED","PRIMARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","SECONDARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","SSP_PRIMARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","SSP_SECONDARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","BREAK_PARTIALLY_SUCCEEDED","CANCELLED","NONE"],"type":"string"},"deviceName":{"description":"Name of the device","type":"string"},"deviceUUID":{"description":"UUID of the device","type":"string"}},"$$ref":"#/components/schemas/IDeviceListEntry"},"type":"array"},"endTime":{"description":"Indicates the end time (in ISO 8601 format) of the deployment job.","type":"string"},"id":{"description":"UUID of the deployment job.","type":"string"},"jobName":{"description":"Name of the deployed job","type":"string"},"jobStatus":{"description":"Represents the status of the job","enum":["DEPLOYING","DEPLOYED","FAILED","ABORTED","EDIT_INUSE"],"type":"string"},"jobType":{"enum":["DEPLOYMENT","ROLLBACK","CERTIFICATE","UNKNOWN"],"type":"string"},"startTime":{"description":"Indicates the start time (in ISO 8601 format) of the deployment job.","type":"string"},"type":{"description":"Type must be JobHistory.","type":"string"},"user":{"description":"Creator of the deployment task.","type":"string"}},"$$ref":"#/components/schemas/JobHistory"}}},"description":"The input representation of Job History model.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : PUT /fmc_config/v1/domain/DomainUUID/deployment/jobhistories/{jobId} ( Update job note for a job. )":{"value":{"items":[{"deploymentNote":"Updated note","deviceList":[{"deployedVersion":2,"deploymentStatus":"SUCCEEDED","deviceName":"10.10.6.104","deviceUUID":"d0c422c8-9756-11ea-acb6-961f407b1a9c"},{"containerName":"vFTD-HA","containerUUID":"8c363564-518d-11eb-899b-e37ea1f51142","deployedVersion":2,"deploymentStatus":"SUCCEEDED","deviceName":"10.10.6.100","deviceUUID":"a6b42c18-50c8-11eb-8556-880cc814430c"},{"deployedVersion":2,"deploymentStatus":"SUCCEEDED","deviceName":"10.10.6.102","deviceUUID":"73dee6c4-9756-11ea-b7d5-c46fa36556b5"}],"endTime":"2020-05-16T10:30:26Z","id":"0050568B-9937-0ed3-0000-463856468766","jobName":"Deploy_Job_6","jobStatus":"Deployed","jobType":"DEPLOYMENT","startTime":"2020-05-16T10:29:01Z","type":"JobHistory","user":"admin"}],"links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/deployment/jobhistories/{0050568B-9937-0ed3-0000-463856468766}"},"paging":{"count":1,"limit":1,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"deploymentNote":{"description":"User provided job note","type":"string"},"deviceList":{"description":"List of devices which have been part of the job.","items":{"type":"object","properties":{"canRollback":{"description":"Indicates whether the deployed version to device in the deployment job is rollback capable. This field is available only if context filter parameter has value as RollbackApplicable.","type":"boolean"},"containerName":{"description":"Name of the container. This will still be displayed after deletion.","type":"string"},"containerUUID":{"description":"UUID of the container","type":"string"},"deployedVersion":{"description":"Config version of the device in the deployment job","format":"int32","type":"integer"},"deploymentStatus":{"description":"Deployment status of the device in the deployment job","enum":["DEPLOYING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","SSP_SUCCEEDED","SSP_FAILED","SSP_PRIMARY_BOOTSTRAP_SUCCEEDED","SSP_PRIMARY_BOOTSTRAP_FAILED","SSP_SECONDARY_BOOTSTRAP_SUCCEEDED","SSP_SECONDARY_BOOTSTRAP_FAILED","PRIMARY_BOOTSTRAP_SUCCEEDED","PRIMARY_BOOTSTRAP_FAILED","SECONDARY_BOOTSTRAP_SUCCEEDED","SECONDARY_BOOTSTRAP_FAILED","BREAK_SUCCEEDED","BREAK_FAILED","PRIMARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","SECONDARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","SSP_PRIMARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","SSP_SECONDARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","BREAK_PARTIALLY_SUCCEEDED","CANCELLED","NONE"],"type":"string"},"deviceName":{"description":"Name of the device","type":"string"},"deviceUUID":{"description":"UUID of the device","type":"string"}},"$$ref":"#/components/schemas/IDeviceListEntry"},"type":"array"},"endTime":{"description":"Indicates the end time (in ISO 8601 format) of the deployment job.","type":"string"},"id":{"description":"UUID of the deployment job.","type":"string"},"jobName":{"description":"Name of the deployed job","type":"string"},"jobStatus":{"description":"Represents the status of the job","enum":["DEPLOYING","DEPLOYED","FAILED","ABORTED","EDIT_INUSE"],"type":"string"},"jobType":{"enum":["DEPLOYMENT","ROLLBACK","CERTIFICATE","UNKNOWN"],"type":"string"},"startTime":{"description":"Indicates the start time (in ISO 8601 format) of the deployment job.","type":"string"},"type":{"description":"Type must be JobHistory.","type":"string"},"user":{"description":"Creator of the deployment task.","type":"string"}},"$$ref":"#/components/schemas/JobHistory"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Deployment"],"__originalOperationId":"updateJobHistory","method":"put","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/jobhistories/{objectId}"}}