> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/api-reference/efalia-process-api/view.md).

# View

## Apply a View Action

> Execute an action on multiple documents from a view. The posted payload is the list\
> &#x20;of documentId to apply the action to.

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"View","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/view/{viewId}/{actionId}":{"post":{"summary":"Apply a View Action","description":"Execute an action on multiple documents from a view. The posted payload is the list\n of documentId to apply the action to.","operationId":"applyViewAction","deprecated":false,"tags":["View"],"parameters":[{"name":"viewId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}}},"responses":{"200":{"description":"View action #{actionId} successfully applied to XXX documents from view #{viewId}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Get Embedded View

> \<a href="./#wky-note-incomplete" class="wky-label wky-label-incomplete">Incomplete\</a>\<a href="./#wky-note-switch-actor" class="wky-label wky-label-switch-actor">Switch Actor\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"View","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"View":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"custom":{"type":"boolean"},"chart":{"type":"boolean"},"visible":{"type":"boolean"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ViewColumn"}},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ViewRow"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/ViewAction"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"ViewColumn":{"type":"object","properties":{"label":{"type":"string"},"name":{"type":"string"},"hidden":{"type":"boolean"},"sort":{"type":"string"},"grouped":{"type":"boolean"},"spanned":{"type":"boolean"},"action":{"type":"string"},"appearance":{"type":"string"}}},"ViewRow":{"type":"object","properties":{"document":{"$ref":"#/components/schemas/RowDocument"},"cells":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}},"RowDocument":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"documentTypeId":{"type":"integer"},"processTypeId":{"type":"integer"},"documentTypeName":{"type":"string"},"processTypeName":{"type":"string"}}},"ViewAction":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"confirmationRequired":{"type":"boolean"},"javaClassName":{"type":"string"},"icon":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}}}}]},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/view/{viewId}/{documentId}":{"get":{"summary":"Get Embedded View","description":"<a href=\"./#wky-note-incomplete\" class=\"wky-label wky-label-incomplete\">Incomplete</a><a href=\"./#wky-note-switch-actor\" class=\"wky-label wky-label-switch-actor\">Switch Actor</a>","operationId":"getViewEmbeddedDocument","deprecated":false,"tags":["View"],"parameters":[{"name":"viewId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"actor","in":"query","description":"🔄 If the user is a *Workflow Manager*, this parameter allow the user to make the request on behalf of the chosen actor. This parameter value can either be the actor `Id` or their `Dn`.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/View"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Get View

> \<a href="./#wky-note-switch-actor" class="wky-label wky-label-switch-actor">Switch Actor\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"View","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"View":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"custom":{"type":"boolean"},"chart":{"type":"boolean"},"visible":{"type":"boolean"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ViewColumn"}},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ViewRow"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/ViewAction"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"ViewColumn":{"type":"object","properties":{"label":{"type":"string"},"name":{"type":"string"},"hidden":{"type":"boolean"},"sort":{"type":"string"},"grouped":{"type":"boolean"},"spanned":{"type":"boolean"},"action":{"type":"string"},"appearance":{"type":"string"}}},"ViewRow":{"type":"object","properties":{"document":{"$ref":"#/components/schemas/RowDocument"},"cells":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}},"RowDocument":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"documentTypeId":{"type":"integer"},"processTypeId":{"type":"integer"},"documentTypeName":{"type":"string"},"processTypeName":{"type":"string"}}},"ViewAction":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"confirmationRequired":{"type":"boolean"},"javaClassName":{"type":"string"},"icon":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}}}}]},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/view/{viewId}":{"get":{"summary":"Get View","description":"<a href=\"./#wky-note-switch-actor\" class=\"wky-label wky-label-switch-actor\">Switch Actor</a>","operationId":"getView","deprecated":false,"tags":["View"],"parameters":[{"name":"viewId","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"integer"},"required":false,"description":"If the both \"from\" and \"to\" are present, a slice of the view is fetched."},{"name":"to","in":"query","schema":{"type":"integer"},"required":false,"description":"If the both \"from\" and \"to\" are present, a slice of the view is fetched."},{"name":"page_size","in":"query","schema":{"type":"integer"},"required":false,"description":"Alternatively to the ``{from}`` and ``{to}`` parameters, If the both \"page_size\" and \"offset\" are present, a slice of the view is fetched."},{"name":"offset","in":"query","schema":{"type":"integer"},"required":false,"description":"Alternatively to the ``{from}`` and ``{to}`` parameters, If the both \"page_size\" and \"offset\" are present, a slice of the view is fetched."},{"name":"specifications","in":"query","schema":{"type":"string"},"required":false,"description":"If set, the returned view will only contains the specification of the columns, without the content rows."},{"name":"lang","in":"query","schema":{"type":"string"},"required":false,"description":"Language to use to localize the view. By default the language of the current actor is used."},{"name":"actor","in":"query","description":"🔄 If the user is a *Workflow Manager*, this parameter allow the user to make the request on behalf of the chosen actor. This parameter value can either be the actor `Id` or their `Dn`.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/View"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.efalia.com/api-reference/efalia-process-api/view.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.