Form Assignments

Listing all Form Assignments

Changed on

This will list every assignment upon this Form, in the form of actorId/roleId pairs.

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.

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

Request

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

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

Response

This is the Extended Metadata response, if requested via the appropriate header:

actorIdnumber

The numeric Actor ID being assigned.

roleIdnumber

The numeric Role ID being assigned.

Example response

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

Changes