Project Assignments

Seeing Role-specific Form Assignments within a Project

Changed on

Like the Form Assignments summary API, but filtered by some roleId.

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/{roleId}

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/{roleId}
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

roleIdnumber required

The numeric ID of the Role

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