Get available attribute element for document/dossier's attribute element prompt
GET {{baseUrl}}/api/documents/:id/instances/:instanceId/prompts/:promptIdentifier/elements?offset=0&limit=100&searchPattern=Excepteur Lorem&fields=Excepteur Lorem
Get a list of available elements for answering a specific attribute element prompt in a specific document/dossier within a project. The elements are defined in the prompt definition and can be changed in Web/Developer. The elements can be a pre-defined list or search result. Obtain the authorization token needed to execute the request using POST /auth/login. Obtain the project ID using GET /projects. Pass the authorization token and project ID in the request header. Pass the document/dossier ID and prompt identifier, such as the prompt key or ID, in the path of the request. Use the offset and limit query parameters to control paging behavior. The offset parameter specifies where to start returning results. The limit parameter specifies how many results to return. Use the searchPattern query parameter to define a search pattern to apply, such as Begins With or Exactly.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
offset | number | Starting point within the collection of returned results. Used to control paging behavior. | |
limit | number | Maximum number of items returned for a single request. Used to control paging behavior. Maximum value: 200 | |
searchPattern | string | Search pattern | |
fields | string | Comma separated top-level field whitelist. This allows client to selectively retrieve part of the response model. If specified, extra filtering will be applied, and for top-level object (if root model is an array, each array element), only the listed fields will be kept in the response. e.g. "id,elements" means to keep only the "id" field and the whole "elements" array field, omitting all other fields of top-level response model. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-MSTR-AuthToken | string | (Required) Authorization token | |
X-MSTR-ProjectID | string | (Required) Project ID |
RESPONSES
status: OK
{}