GEgetodk
Project Assignments

Seeing all Form Assignments within a Project

Changed on

Returns a summary of all Form-specific Assignments within this Project. This endpoint is meant to simplify the task of summarizing all Form permissions within a Project at a glance and in one transactional request. Because it is necessary to specify which Form each Assignment is attached to, returned results form this endpoint include an xmlFormId field.

This endpoint supports retrieving extended metadata; provide a header X-Extended-Metadata: true to expand the actorId into a full actor objects. The Role reference remains a numeric ID and the Form reference remains a string ID.

get/v1/projects/{projectId}/assignments/forms

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/assignments/forms
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

Response

OK

actorIdnumber required

The numeric Actor ID being assigned.

xmlFormIdstring required

The id of the assigned form as given in its XForms XML definition

roleIdnumber required

The numeric Role ID being assigned.

Example response

[
  {
    "actorId": 42,
    "xmlFormId": "simple",
    "roleId": 4
  }
]

Changes