Sign in
Project Assignments

Seeing Role-specific Form Assignments within a Project

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}

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

Changed in 3 of the 54 revisions of this API.4

  • 022694254f0d1See the full diff
    • ○

      api operation id Seeing Role-specific Form Assignments within a Project removed and replaced with getRoleSpecificProjectFormAssignments

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb2See the full diff
    • ○

      api operation id getRoleSpecificProjectFormAssignments removed and replaced with Seeing Role-specific Form Assignments within a Project

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog