ReadRequest

A ReadRequest object defines the parameters for the read() command.

A ReadRequest object has the following properties:

Name	Type	Description
`type`	`string`	The type of object to return. For information about supported object types, see List of Supported Business Object Types.
`method`	`string`	The name of the read method to be used. The read method lets you specify whether to return all objects, only the objects matching or not matching a search query object, or the custom field values for a specific object. See Read Methods.
`objects`	`oaBase[]`	An array of `oaBase` objects as arguments.
`attributes`	`Attribute[]`	An array of `Attribute` objects. The attributes lets you modify the response when reading objects using the SOAP API. Some attributes control API features available for most supported object types, other attributes can only be used when reading a specific object type. See Read Attributes.
`fields`	`string`	Comma-separated list of object properties to return. If empty, the response includes all standard object properties for each returned object except for the `flags` property for `oaUser` or `oaCompany` objects (see `User` and `Company`). It also includes all custom fields for the object type. To include the `flags` property for `oaUser` or `oaCompany` objects, set the `include_flags` attribute to `1`.

Name

Type

Description

type

string

The type of object to return. For information about supported object types, see List of Supported Business Object Types.

method

string

The name of the read method to be used. The read method lets you specify whether to return all objects, only the objects matching or not matching a search query object, or the custom field values for a specific object. See Read Methods.

objects

oaBase[]

An array of oaBase objects as arguments.

attributes

Attribute[]

An array of Attribute objects. The attributes lets you modify the response when reading objects using the SOAP API. Some attributes control API features available for most supported object types, other attributes can only be used when reading a specific object type. See Read Attributes.

fields

string

Comma-separated list of object properties to return.

If empty, the response includes all standard object properties for each returned object except for the flags property for oaUser or oaCompany objects (see User and Company). It also includes all custom fields for the object type. To include the flags property for oaUser or oaCompany objects, set the include_flags attribute to 1.