odata

Read one entity set

Returns rows of the named set in an OData v4 JSON envelope. Server-paged: $top defaults to 500 and is capped at 1000; a full page carries @odata.nextLink, follow it until a short page. $filter supports one <Property> eq '<value>' clause on the set's key-like columns (ProjectId, TaskId, ResourceId, ...); $expand, $apply and $search are refused with a 400 rather than silently ignored. Visibility is the project list's: a token sees the projects its owner can see, TimesheetLines are the owner's own unless they can view all projects, and a project-scoped token sees only its projects.

get/odata/{entitySet}

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/odata/{entitySet}
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

entitySet'Projects' | 'Tasks' | 'Assignments' | 'Resources' | 'TimesheetLines' | 'CustomFieldValues' | 'TaskBaselines' required

Query parameters

$topinteger

Page size, default 500, capped at 1000.

$skipinteger
$countboolean

Include @odata.count (the filtered total).

$filterstring

One clause: ProjectId eq 'cm...'.

Response

{ "@odata.context", "@odata.count"?, "value": [...], "@odata.nextLink"? }

Changes

No recorded changes to this operation across all 1 revision of this API.