{"type":"api","title":"Add a Workflow","meta":{"id":"/apps/pubhub/media/dna-center-235/0e427c513038595590fc5a0593cb0e208dd78571/2192edf3-d24e-3461-ab8c-12a97b547df4","swagger":"2.0","info":{"description":"Cisco DNA Center Platform v. 2.3.5","version":"2.3.5","title":"Intent API"},"schemes":["https"],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}}},"spec":{"operationId":"addAWorkflow","tags":["Device Onboarding (PnP)"],"summary":"Add a Workflow","description":"Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","description":"request","required":true,"schema":{"type":"object","properties":{"_id":{"type":"string"},"addToInventory":{"type":"boolean"},"addedOn":{"type":"integer"},"configId":{"type":"string"},"currTaskIdx":{"type":"integer"},"description":{"type":"string"},"endTime":{"type":"integer"},"execTime":{"type":"integer"},"imageId":{"type":"string"},"instanceType":{"type":"string","enum":["SystemWorkflow","UserWorkflow","SystemResetWorkflow"]},"lastupdateOn":{"type":"integer"},"name":{"type":"string"},"startTime":{"type":"integer"},"state":{"type":"string"},"tasks":{"type":"array","items":{"type":"object","properties":{"currWorkItemIdx":{"type":"integer"},"endTime":{"type":"integer"},"name":{"type":"string"},"startTime":{"type":"integer"},"state":{"type":"string"},"taskSeqNo":{"type":"integer"},"timeTaken":{"type":"integer"},"type":{"type":"string"},"workItemList":{"type":"array","items":{"type":"object","properties":{"command":{"type":"string"},"endTime":{"type":"integer"},"outputStr":{"type":"string"},"startTime":{"type":"integer"},"state":{"type":"string"},"timeTaken":{"type":"integer"}}}}}}},"tenantId":{"type":"string"},"type":{"type":"string"},"useState":{"type":"string"},"version":{"type":"integer"}},"$$ref":"#/definitions/Workflow"},"in":"body"},{"name":"Content-Type","description":"Request body content type","default":"application/json","required":true,"type":"string","in":"header"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","schema":{"type":"object","properties":{"_id":{"type":"string"},"state":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"lastupdateOn":{"type":"number"},"imageId":{"type":"string"},"currTaskIdx":{"type":"number"},"addedOn":{"type":"number"},"tasks":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"type":{"type":"string"},"currWorkItemIdx":{"type":"number"},"taskSeqNo":{"type":"number"},"endTime":{"type":"number"},"startTime":{"type":"number"},"workItemList":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"command":{"type":"string"},"outputStr":{"type":"string"},"endTime":{"type":"number"},"startTime":{"type":"number"},"timeTaken":{"type":"number"}}}},"timeTaken":{"type":"number"},"name":{"type":"string"}}}},"addToInventory":{"type":"boolean"},"instanceType":{"type":"string"},"endTime":{"type":"number"},"execTime":{"type":"number"},"startTime":{"type":"number"},"useState":{"type":"string"},"configId":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"},"tenantId":{"type":"string"}},"$$ref":"#/definitions/AddAWorkflowResponse"}},"201":{"description":"The POST/PUT request was fulfilled and a new resource has been created. Information about the resource is in the response body."},"202":{"description":"The request was accepted for processing, but the processing has not been completed."},"204":{"description":"The request was successful, however no content was returned."},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range."},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect)."},"401":{"description":"The client's authentication credentials included with the request are missing or invalid."},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"404":{"description":"The client made a request for a resource that does not exist."},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed."},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON)."},"500":{"description":"The server could not fulfill the request."},"501":{"description":"The server has not implemented the functionality required to fulfill the request."},"503":{"description":"The server is (temporarily) unavailable."},"504":{"description":"The server did not respond inside time restrictions and timed-out."}},"__originalOperationId":"addAWorkflow","method":"post","path":"/dna/intent/api/v1/onboarding/pnp-workflow"}}