original_docstring: Adds a PnP Workflow along with the relevant tasks in the
          workflow into the PnP database.
  
          Args:
              _id(string): Workflow's _id.
              addToInventory(boolean): Workflow's addToInventory.
              addedOn(number): Workflow's addedOn.
              configId(string): Workflow's configId.
              currTaskIdx(number): Workflow's currTaskIdx.
              description(string): Workflow's description.
              endTime(number): Workflow's endTime.
              execTime(number): Workflow's execTime.
              imageId(string): Workflow's imageId.
              instanceType(string): Workflow's instanceType. Available values are 'SystemWorkflow', 'UserWorkflow' and
                  'SystemResetWorkflow'.
              lastupdateOn(number): Workflow's lastupdateOn.
              name(string): Workflow's name.
              startTime(number): Workflow's startTime.
              state(string): Workflow's state.
              tasks(list): Workflow's tasks (list of objects).
              tenantId(string): Workflow's tenantId.
              type(string): Workflow's type.
              useState(string): Workflow's useState.
              version(number): Workflow's version.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              payload(dict): A JSON serializable Python object to send in the
                  body of the Request.
              active_validation(bool): Enable/Disable payload validation.
                  Defaults to True.
              **request_parameters: Additional request parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              MyDict: JSON response. Access the object's properties by using
              the dot notation or the bracket notation.
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the DNA Center cloud returns an error.
          
docstring: Adds a PnP Workflow along with the relevant tasks in the
  workflow into the PnP database.
docstring_tokens: Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database .
code: def add_a_workflow(self,
                         _id=None,
                         addToInventory=None,
                         addedOn=None,
                         configId=None,
                         currTaskIdx=None,
                         description=None,
                         endTime=None,
                         execTime=None,
                         imageId=None,
                         instanceType=None,
                         lastupdateOn=None,
                         name=None,
                         startTime=None,
                         state=None,
                         tasks=None,
                         tenantId=None,
                         type=None,
                         useState=None,
                         version=None,
                         headers=None,
                         payload=None,
                         active_validation=True,
                         **request_parameters):
          """Adds a PnP Workflow along with the relevant tasks in the
          workflow into the PnP database.
  
          Args:
              _id(string): Workflow's _id.
              addToInventory(boolean): Workflow's addToInventory.
              addedOn(number): Workflow's addedOn.
              configId(string): Workflow's configId.
              currTaskIdx(number): Workflow's currTaskIdx.
              description(string): Workflow's description.
              endTime(number): Workflow's endTime.
              execTime(number): Workflow's execTime.
              imageId(string): Workflow's imageId.
              instanceType(string): Workflow's instanceType. Available values are 'SystemWorkflow', 'UserWorkflow' and
                  'SystemResetWorkflow'.
              lastupdateOn(number): Workflow's lastupdateOn.
              name(string): Workflow's name.
              startTime(number): Workflow's startTime.
              state(string): Workflow's state.
              tasks(list): Workflow's tasks (list of objects).
              tenantId(string): Workflow's tenantId.
              type(string): Workflow's type.
              useState(string): Workflow's useState.
              version(number): Workflow's version.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              payload(dict): A JSON serializable Python object to send in the
                  body of the Request.
              active_validation(bool): Enable/Disable payload validation.
                  Defaults to True.
              **request_parameters: Additional request parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              MyDict: JSON response. Access the object's properties by using
              the dot notation or the bracket notation.
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the DNA Center cloud returns an error.
          """
          check_type(headers, dict)
          check_type(payload, dict)
          if headers is not None:
              if 'Content-Type' in headers:
                  check_type(headers.get('Content-Type'),
                             basestring, may_be_none=False)
              if 'X-Auth-Token' in headers:
                  check_type(headers.get('X-Auth-Token'),
                             basestring, may_be_none=False)
  
          _params = {
          }
          _params.update(request_parameters)
          _params = dict_from_items_with_values(_params)
  
          path_params = {
          }
  
          _payload = {
              '_id':
                  _id,
              'addToInventory':
                  addToInventory,
              'addedOn':
                  addedOn,
              'configId':
                  configId,
              'currTaskIdx':
                  currTaskIdx,
              'description':
                  description,
              'endTime':
                  endTime,
              'execTime':
                  execTime,
              'imageId':
                  imageId,
              'instanceType':
                  instanceType,
              'lastupdateOn':
                  lastupdateOn,
              'name':
                  name,
              'startTime':
                  startTime,
              'state':
                  state,
              'tasks':
                  tasks,
              'tenantId':
                  tenantId,
              'type':
                  type,
              'useState':
                  useState,
              'version':
                  version,
          }
          _payload.update(payload or {})
          _payload = dict_from_items_with_values(_payload)
          if active_validation:
              self._request_validator('jsd_848b5a7b4f9b8c12_v1_3_1')\
                  .validate(_payload)
  
          with_custom_headers = False
          _headers = self._session.headers or {}
          if headers:
              _headers.update(dict_of_str(headers))
              with_custom_headers = True
  
          e_url = ('/dna/intent/api/v1/onboarding/pnp-workflow')
          endpoint_full_url = apply_path_params(e_url, path_params)
          if with_custom_headers:
              json_data = self._session.post(endpoint_full_url, params=_params,
                                             json=_payload,
                                             headers=_headers)
          else:
              json_data = self._session.post(endpoint_full_url, params=_params,
                                             json=_payload)
  
          return self._object_factory('bpm_848b5a7b4f9b8c12_v1_3_1', json_data)
code_tokens: def add_a_workflow ( self , _id = None , addToInventory = None , addedOn = None , configId = None , currTaskIdx = None , description = None , endTime = None , execTime = None , imageId = None , instanceType = None , lastupdateOn = None , name = None , startTime = None , state = None , tasks = None , tenantId = None , type = None , useState = None , version = None , headers = None , payload = None , active_validation = True , ** request_parameters ) : check_type ( headers , dict ) check_type ( payload , dict ) if headers is not None : if 'Content-Type' in headers : check_type ( headers . get ( 'Content-Type' ) , basestring , may_be_none = False ) if 'X-Auth-Token' in headers : check_type ( headers . get ( 'X-Auth-Token' ) , basestring , may_be_none = False ) _params = { } _params . update ( request_parameters ) _params = dict_from_items_with_values ( _params ) path_params = { } _payload = { '_id' : _id , 'addToInventory' : addToInventory , 'addedOn' : addedOn , 'configId' : configId , 'currTaskIdx' : currTaskIdx , 'description' : description , 'endTime' : endTime , 'execTime' : execTime , 'imageId' : imageId , 'instanceType' : instanceType , 'lastupdateOn' : lastupdateOn , 'name' : name , 'startTime' : startTime , 'state' : state , 'tasks' : tasks , 'tenantId' : tenantId , 'type' : type , 'useState' : useState , 'version' : version , } _payload . update ( payload or { } ) _payload = dict_from_items_with_values ( _payload ) if active_validation : self . _request_validator ( 'jsd_848b5a7b4f9b8c12_v1_3_1' ) . validate ( _payload ) with_custom_headers = False _headers = self . _session . headers or { } if headers : _headers . update ( dict_of_str ( headers ) ) with_custom_headers = True e_url = ( '/dna/intent/api/v1/onboarding/pnp-workflow' ) endpoint_full_url = apply_path_params ( e_url , path_params ) if with_custom_headers : json_data = self . _session . post ( endpoint_full_url , params = _params , json = _payload , headers = _headers ) else : json_data = self . _session . post ( endpoint_full_url , params = _params , json = _payload ) return self . _object_factory ( 'bpm_848b5a7b4f9b8c12_v1_3_1' , json_data )
short_docstring: Adds a PnP Workflow along with the relevant tasks in the
  workflow into the PnP database.
short_docstring_tokens: Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database .
comment: """Adds a PnP Workflow along with the relevant tasks in the
          workflow into the PnP database.
  
          Args:
              _id(string): Workflow's _id.
              addToInventory(boolean): Workflow's addToInventory.
              addedOn(number): Workflow's addedOn.
              configId(string): Workflow's configId.
              currTaskIdx(number): Workflow's currTaskIdx.
              description(string): Workflow's description.
              endTime(number): Workflow's endTime.
              execTime(number): Workflow's execTime.
              imageId(string): Workflow's imageId.
              instanceType(string): Workflow's instanceType. Available values are 'SystemWorkflow', 'UserWorkflow' and
                  'SystemResetWorkflow'.
              lastupdateOn(number): Workflow's lastupdateOn.
              name(string): Workflow's name.
              startTime(number): Workflow's startTime.
              state(string): Workflow's state.
              tasks(list): Workflow's tasks (list of objects).
              tenantId(string): Workflow's tenantId.
              type(string): Workflow's type.
              useState(string): Workflow's useState.
              version(number): Workflow's version.
              headers(dict): Dictionary of HTTP Headers to send with the Request
                  .
              payload(dict): A JSON serializable Python object to send in the
                  body of the Request.
              active_validation(bool): Enable/Disable payload validation.
                  Defaults to True.
              **request_parameters: Additional request parameters (provides
                  support for parameters that may be added in the future).
  
          Returns:
              MyDict: JSON response. Access the object's properties by using
              the dot notation or the bracket notation.
  
          Raises:
              TypeError: If the parameter types are incorrect.
              MalformedRequest: If the request body created is invalid.
              ApiError: If the DNA Center cloud returns an error.
          """