lib/hubspot/codegen/crm/objects/api/batch_api.rb
# Read a batch of objects by internal ID, or unique property values
# Read a list of objects given a collection of IDs. Use the &#x60;properties&#x60; request body property to control which properties are returned.
# @param object_type [String] 
# @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId] 
# @param [Hash] opts the optional parameters
# @option opts [Boolean] :archived Whether to return only results that have been archived.
# @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
Read a batch of objects by internal ID, or unique property values
Read a list of objects given a collection of IDs. Use the `properties` request body property to control which properties are returned.
Read a batch of objects by internal ID or unique property values Read a list of objects given a collection of IDs . Use the ` properties ` request body property to control which properties are returned .
def read_with_http_info(object_type, batch_read_input_simple_public_object_id, opts = {})
          if @api_client.config.debugging
            @api_client.config.logger.debug 'Calling API: BatchApi.read ...'
          end
          if @api_client.config.client_side_validation && object_type.nil?
            fail ArgumentError, "Missing the required parameter 'object_type' when calling BatchApi.read"
          end
          if @api_client.config.client_side_validation && batch_read_input_simple_public_object_id.nil?
            fail ArgumentError, "Missing the required parameter 'batch_read_input_simple_public_object_id' when calling BatchApi.read"
          end
          local_var_path = '/crm/v3/objects/{objectType}/batch/read'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s))
          query_params = opts[:query_params] || {}
          query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
          header_params = opts[:header_params] || {}
          header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
          header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
          form_params = opts[:form_params] || {}
          post_body = opts[:body] || @api_client.object_to_http_body(batch_read_input_simple_public_object_id) 
          return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 
          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
          new_options = opts.merge(
            :header_params => header_params,
            :query_params => query_params,
            :form_params => form_params,
            :body => post_body,
            :auth_names => auth_names,
            :return_type => return_type
          )
          data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
          if @api_client.config.debugging
            @api_client.config.logger.debug "API called: BatchApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
          end
          return data, status_code, headers
        end
def read_with_http_info ( object_type , batch_read_input_simple_public_object_id , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: BatchApi.read ...' end if @api_client . config . client_side_validation && object_type . nil? fail ArgumentError , "Missing the required parameter 'object_type' when calling BatchApi.read" end if @api_client . config . client_side_validation && batch_read_input_simple_public_object_id . nil? fail ArgumentError , "Missing the required parameter 'batch_read_input_simple_public_object_id' when calling BatchApi.read" end local_var_path = '/crm/v3/objects/{objectType}/batch/read' . sub ( '{' + 'objectType' + '}' , CGI . escape ( object_type . to_s ) ) query_params = opts [ :query_params ] || { } query_params [ :' archived ' ] = opts [ :' archived ' ] if ! opts [ :' archived ' ] . nil? header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' , '*/*' ] ) header_params [ 'Content-Type' ] = @api_client . select_header_content_type ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :body ] || @api_client . object_to_http_body ( batch_read_input_simple_public_object_id ) return_type = opts [ :return_type ] || 'BatchResponseSimplePublicObject' auth_names = opts [ :auth_names ] || [ 'hapikey' , 'oauth2' ] new_options = opts . merge ( :header_params => header_params , :query_params => query_params , :form_params => form_params , :body => post_body , :auth_names => auth_names , :return_type => return_type ) data , status_code , headers = @api_client . call_api ( :POST , local_var_path , new_options ) if @api_client . config . debugging @api_client . config . logger . debug "API called: BatchApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Read a batch of objects by internal ID, or unique property values
Read a list of objects given a collection of IDs.
Read a batch of objects by internal ID or unique property values Read a list of objects given a collection of IDs .
# verify the required parameter 'object_type' is set # verify the required parameter 'batch_read_input_simple_public_object_id' is set # resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # HTTP header 'Content-Type' # form parameters # http body (model) # return_type # auth_names
BatchResponseSimplePublicObject data, response status code and response headers
BatchResponseSimplePublicObject data response status code and response headers
Array<(BatchResponseSimplePublicObject, Integer, Hash)>
object_type
<not_specific>
batch_read_input_simple_public_object_id
<not_specific>
opts
:archived Whether to return only results that have been archived.
: archived Whether to return only results that have been archived .
<not_specific>
None
<not_specific>
opts the optional parameters
opts the optional parameters