original_docstring: Claims one of more devices with specified workflow.
  
          Args:
              configFileUrl(string): ClaimDeviceRequest's configFileUrl.
              configId(string): ClaimDeviceRequest's configId.
              deviceClaimList(list): ClaimDeviceRequest's deviceClaimList (list of objects).
              fileServiceId(string): ClaimDeviceRequest's fileServiceId.
              imageId(string): ClaimDeviceRequest's imageId.
              imageUrl(string): ClaimDeviceRequest's imageUrl.
              populateInventory(boolean): ClaimDeviceRequest's populateInventory.
              projectId(string): ClaimDeviceRequest's projectId.
              workflowId(string): ClaimDeviceRequest's workflowId.
              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: Claims one of more devices with specified workflow.
docstring_tokens: Claims one of more devices with specified workflow .
code: def claim_device(self,
                       configFileUrl=None,
                       configId=None,
                       deviceClaimList=None,
                       fileServiceId=None,
                       imageId=None,
                       imageUrl=None,
                       populateInventory=None,
                       projectId=None,
                       workflowId=None,
                       headers=None,
                       payload=None,
                       active_validation=True,
                       **request_parameters):
          """Claims one of more devices with specified workflow.
  
          Args:
              configFileUrl(string): ClaimDeviceRequest's configFileUrl.
              configId(string): ClaimDeviceRequest's configId.
              deviceClaimList(list): ClaimDeviceRequest's deviceClaimList (list of objects).
              fileServiceId(string): ClaimDeviceRequest's fileServiceId.
              imageId(string): ClaimDeviceRequest's imageId.
              imageUrl(string): ClaimDeviceRequest's imageUrl.
              populateInventory(boolean): ClaimDeviceRequest's populateInventory.
              projectId(string): ClaimDeviceRequest's projectId.
              workflowId(string): ClaimDeviceRequest's workflowId.
              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 = {
              'configFileUrl':
                  configFileUrl,
              'configId':
                  configId,
              'deviceClaimList':
                  deviceClaimList,
              'fileServiceId':
                  fileServiceId,
              'imageId':
                  imageId,
              'imageUrl':
                  imageUrl,
              'populateInventory':
                  populateInventory,
              'projectId':
                  projectId,
              'workflowId':
                  workflowId,
          }
          _payload.update(payload or {})
          _payload = dict_from_items_with_values(_payload)
          if active_validation:
              self._request_validator('jsd_d8a619974a8a8c48_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-device/claim')
          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_d8a619974a8a8c48_v1_3_1', json_data)
code_tokens: def claim_device ( self , configFileUrl = None , configId = None , deviceClaimList = None , fileServiceId = None , imageId = None , imageUrl = None , populateInventory = None , projectId = None , workflowId = 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 = { 'configFileUrl' : configFileUrl , 'configId' : configId , 'deviceClaimList' : deviceClaimList , 'fileServiceId' : fileServiceId , 'imageId' : imageId , 'imageUrl' : imageUrl , 'populateInventory' : populateInventory , 'projectId' : projectId , 'workflowId' : workflowId , } _payload . update ( payload or { } ) _payload = dict_from_items_with_values ( _payload ) if active_validation : self . _request_validator ( 'jsd_d8a619974a8a8c48_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-device/claim' ) 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_d8a619974a8a8c48_v1_3_1' , json_data )
short_docstring: Claims one of more devices with specified workflow.
short_docstring_tokens: Claims one of more devices with specified workflow .
comment: """Claims one of more devices with specified workflow.
  
          Args:
              configFileUrl(string): ClaimDeviceRequest's configFileUrl.
              configId(string): ClaimDeviceRequest's configId.
              deviceClaimList(list): ClaimDeviceRequest's deviceClaimList (list of objects).
              fileServiceId(string): ClaimDeviceRequest's fileServiceId.
              imageId(string): ClaimDeviceRequest's imageId.
              imageUrl(string): ClaimDeviceRequest's imageUrl.
              populateInventory(boolean): ClaimDeviceRequest's populateInventory.
              projectId(string): ClaimDeviceRequest's projectId.
              workflowId(string): ClaimDeviceRequest's workflowId.
              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.
          """