Troubleshooting · Developer docs

Troubleshooting

Grouped by symptom, never by module, because the person with the problem does not know which module has it. One hundred questions across ten pages, each answered with the causes in the order they usually turn out to be true.

Answer API requests

My properties fields come back as "Error: Getter for property … not found", or glued together

Published

Both answer HTTP 200, so only the body shows them.

  • Glued together: the fields in a selector are separated by commas or line breaks, never by spaces. {id name} asks for one field called idname, and every record comes back as {"idname": "Error: Getter for property idname … not found"}.
  • An error on one field: the record type has no property of that name, or it is spelt differently. The string names the class it looked in, such as Faq\Models\Api\Response\Page, which tells you which record in a nested selector it was.

The properties each record type has are on its page in the API reference. Layout area values are read with a getter and an alias, summary:areaText(summary), not as a property named after the area.

HTTP 
GET /cdna-api/pages/page/1885?properties={id,name}                      fields separated by a comma
GET /cdna-api/pages/page/1885?properties={id,
  name}                                                                  or a line break
GET /cdna-api/pages/page/1885?properties={id,nav:areaText(navSection)}  an area, through a getter

More in Shaping the response with properties.

In the API reference: Shaping the response with properties.

More in API requests

  1. "414 Request-URI Too Long", or my long properties selector stops working
  2. The selector in my GET body was ignored, and the full record came back
  3. My filter returned every record
  4. A custom entity list answers a totalCount but no rows
  5. The API answers 404 for a record that exists

Was this page helpful?

Your answer goes to the docs team.