# List Objects

Retrieves all objects (including details) of the specified type. A filter can be applied.


>Information: Certain data elements (e.g. lookup table values of any table, including JSON lookup tables / pricing params) should NOT be retrieved with the general fetch commands (/fetch/{TypeCode}). Always use the "...manager.fetch" API endpoints where they are available. The same applies to update/delete/integrate commands.


>Information: The following entities can intentionally be fetched by any user without any particular user role: CN, BR, CS, CLLIAM, CTAM, CTT, CTTAM, C, CAM, CXAM, DMDC, DMF, DMDL, DMDS, DM, DMM, DMR, DMT, DCRAM, FN, IE, JST, JLTVM, MPLIT, MPLAM, MLTVM, MRAM, MT, PYRAM, PGIM, PRAM, PLIM, P, PAM, PXAM, QAM, RBAAM, RRAM, RRS, RRSC, RBT, RBTAM, SC, SCN, SCNAM, SIM, SIAM, UG.

You can choose fields to be returned in the response by employing the resultFields or valueFields filter:
resultFields: returns key-value pairs as objects. This is the more friendly response compared to valueFields but the server fetches all fields from the database in the backend which might result in a slower performance. See the List Product's listProductsResponseExample_resultFields response example.
valueFields: returns just an array of values. Use this option if a better performance is required. See the List Product's listProductsResponseExample_valueFields response example.

Endpoint: POST /fetch/{TypeCode}
Security: basic, X-PriceFx-jwt

## Path parameters:

  - `TypeCode` (string, required)
    The object's type code. See the list of Type Codes.

## Request fields (application/json):

  - `endRow` (integer)
    The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

  - `operationType` (string)

  - `startRow` (integer)
    The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.

  - `textMatchStyle` (string)
    Enum: "startsWith", "exact", "substring"

  - `data` (object)

  - `data._constructor` (string)

  - `data.operator` (string)

  - `data.criteria` (array)

  - `data.criteria.fieldName` (string)

  - `data.criteria.operator` (string)
    Specify an operator of the filter criteria.
    Enum: "equals", "iEquals", "notEqual", "iNotEqual", "greaterThan", "greaterOrEqual", "lessOrEqual", "lessThan", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet"

  - `data.criteria.value` (string)

## Response 200 fields (application/json):

  - `response` (object)

  - `response.node` (string)

  - `response.data` (object,null)

  - `response.status` (integer)

  - `response.startRow` (integer)

  - `response.endRow` (integer)