> 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/agent.md).

# Agent

## Create New Agent

> Create a new agent and add it to the Agent scheduler.\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\
> \### Note\
> Only JSON input is currently supported.

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"Agent":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"executionType":{"$ref":"#/components/schemas/AgentExecutionType"},"period":{"type":"integer","format":"int64"},"cronExpression":{"type":"string"},"start":{"$ref":"#/components/schemas/AgentStart"},"nextLaunch":{"type":"string","format":"date-time"},"previousLaunch":{"type":"string","format":"date-time"},"scheduled":{"type":"boolean"},"completed":{"type":"boolean"},"type":{"$ref":"#/components/schemas/AgentType"},"className":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/AgentParameter"}},"allowMultipleInstance":{"type":"boolean"},"calendar":{"$ref":"#/components/schemas/AgentCalendar"},"actor":{"$ref":"#/components/schemas/WorkeyObject"},"lastExecution":{"type":"string"},"keepHistory":{"type":"boolean"},"history":{"type":"array","items":{"$ref":"#/components/schemas/AgentHistory"}},"possibleActors":{"type":"array","items":{"$ref":"#/components/schemas/Actor"}},"possibleCalendars":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendar"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"AgentExecutionType":{"type":"string","enum":["REPEAT","CRON"]},"AgentStart":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/AgentStartMode"},"date":{"type":"string","format":"date-time"},"delay":{"type":"integer","format":"int64"}}},"AgentStartMode":{"type":"string","enum":["ASAP","COUNTDOWN","FIXED_TIME","FIXED_DATE"]},"AgentType":{"type":"string","enum":["DELAY","ROLE","CUSTOM","VIEW","ARCHIVE","SYNCHRONIZER","DELEGATIONS"]},"AgentParameter":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"select":{"type":"string"}}},"AgentCalendar":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"cronExpression":{"type":"string"},"excludedDates":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendarDate"}}}}]},"AgentCalendarDate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/AgentCalendarDateType"},"formatedDate":{"type":"string"}}},"AgentCalendarDateType":{"type":"string","enum":["ANNUAL","CRON","HOLIDAY","WEEKLY","DAILY"]},"AgentHistory":{"type":"object","properties":{"message":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"Actor":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ActorType"},"language":{"type":"string"},"manager":{"$ref":"#/components/schemas/ActorManager"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"units":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}},"delegations":{"type":"array","items":{"$ref":"#/components/schemas/Delegation"}},"availableDocuments":{"type":"array","items":{"$ref":"#/components/schemas/AvailableDocument"}}}}]},"ActorType":{"type":"string","enum":["AGENT","PERSON","UNIT","CUSTOMER"]},"ActorManager":{"type":"object","properties":{"processes":{"type":"array","items":{"$ref":"#/components/schemas/Process"}},"workflow":{"type":"boolean"},"units":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}}}},"Process":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"documentTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"active":{"type":"boolean"},"version":{"type":"integer"}}}]},"Role":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/Process"},"agent":{"type":"boolean"}}}]},"Unit":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/ActorType"},"dn":{"type":"string"},"cn":{"type":"string"},"childrenUnits":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}}}},"Delegation":{"type":"object","properties":{"role":{"$ref":"#/components/schemas/WorkeyObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"from":{"$ref":"#/components/schemas/WorkeyObject"},"processType":{"$ref":"#/components/schemas/WorkeyObject"},"delegates":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}}},"AvailableDocument":{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/WorkeyObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"role":{"$ref":"#/components/schemas/WorkeyObject"},"url":{"type":"string"}}},"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":{"/agent":{"post":{"summary":"Create New Agent","description":"Create a new agent and add it to the Agent scheduler.\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a>\n### Note\nOnly JSON input is currently supported.","operationId":"createAgent","deprecated":false,"tags":["Agent"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Get New Agent Template

> Get the detail of an agent deployed on the server.\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"Agent":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"executionType":{"$ref":"#/components/schemas/AgentExecutionType"},"period":{"type":"integer","format":"int64"},"cronExpression":{"type":"string"},"start":{"$ref":"#/components/schemas/AgentStart"},"nextLaunch":{"type":"string","format":"date-time"},"previousLaunch":{"type":"string","format":"date-time"},"scheduled":{"type":"boolean"},"completed":{"type":"boolean"},"type":{"$ref":"#/components/schemas/AgentType"},"className":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/AgentParameter"}},"allowMultipleInstance":{"type":"boolean"},"calendar":{"$ref":"#/components/schemas/AgentCalendar"},"actor":{"$ref":"#/components/schemas/WorkeyObject"},"lastExecution":{"type":"string"},"keepHistory":{"type":"boolean"},"history":{"type":"array","items":{"$ref":"#/components/schemas/AgentHistory"}},"possibleActors":{"type":"array","items":{"$ref":"#/components/schemas/Actor"}},"possibleCalendars":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendar"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"AgentExecutionType":{"type":"string","enum":["REPEAT","CRON"]},"AgentStart":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/AgentStartMode"},"date":{"type":"string","format":"date-time"},"delay":{"type":"integer","format":"int64"}}},"AgentStartMode":{"type":"string","enum":["ASAP","COUNTDOWN","FIXED_TIME","FIXED_DATE"]},"AgentType":{"type":"string","enum":["DELAY","ROLE","CUSTOM","VIEW","ARCHIVE","SYNCHRONIZER","DELEGATIONS"]},"AgentParameter":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"select":{"type":"string"}}},"AgentCalendar":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"cronExpression":{"type":"string"},"excludedDates":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendarDate"}}}}]},"AgentCalendarDate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/AgentCalendarDateType"},"formatedDate":{"type":"string"}}},"AgentCalendarDateType":{"type":"string","enum":["ANNUAL","CRON","HOLIDAY","WEEKLY","DAILY"]},"AgentHistory":{"type":"object","properties":{"message":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"Actor":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ActorType"},"language":{"type":"string"},"manager":{"$ref":"#/components/schemas/ActorManager"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"units":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}},"delegations":{"type":"array","items":{"$ref":"#/components/schemas/Delegation"}},"availableDocuments":{"type":"array","items":{"$ref":"#/components/schemas/AvailableDocument"}}}}]},"ActorType":{"type":"string","enum":["AGENT","PERSON","UNIT","CUSTOMER"]},"ActorManager":{"type":"object","properties":{"processes":{"type":"array","items":{"$ref":"#/components/schemas/Process"}},"workflow":{"type":"boolean"},"units":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}}}},"Process":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"documentTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"active":{"type":"boolean"},"version":{"type":"integer"}}}]},"Role":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/Process"},"agent":{"type":"boolean"}}}]},"Unit":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/ActorType"},"dn":{"type":"string"},"cn":{"type":"string"},"childrenUnits":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}}}},"Delegation":{"type":"object","properties":{"role":{"$ref":"#/components/schemas/WorkeyObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"from":{"$ref":"#/components/schemas/WorkeyObject"},"processType":{"$ref":"#/components/schemas/WorkeyObject"},"delegates":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}}},"AvailableDocument":{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/WorkeyObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"role":{"$ref":"#/components/schemas/WorkeyObject"},"url":{"type":"string"}}},"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":{"/agent/new/{agentType}":{"get":{"summary":"Get New Agent Template","description":"Get the detail of an agent deployed on the server.\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a>","operationId":"getNewAgent","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentType","in":"path","required":true,"schema":{"type":"string"},"description":"The type of agent to create. The following types are special agents: <ul>\n   <dt>ARCHIVE</dt><dd></dd><!-- * -->\n   <dt>CUSTOM</dt><dd></dd>\n   <dt>DELAY</dt><dd></dd><!-- * -->\n   <dt>DELEGATIONS</dt><dd></dd><!-- * -->\n   <dt>ROLE</dt><dd></dd>\n   <dt>SYNCHRONIZER</dt><dd></dd><!-- * -->\n   <dt>VIEW</dt><dd></dd>\n </ul>"},{"name":"agentClass","in":"query","schema":{"type":"string"},"required":false,"description":"If the Agent is of type <b>CUSTOM</b> this parameter is required and contains \n the name of the custom class for this agent."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Get Agent Detail

> Get the detail of an agent deployed on the server.\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"Agent":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"executionType":{"$ref":"#/components/schemas/AgentExecutionType"},"period":{"type":"integer","format":"int64"},"cronExpression":{"type":"string"},"start":{"$ref":"#/components/schemas/AgentStart"},"nextLaunch":{"type":"string","format":"date-time"},"previousLaunch":{"type":"string","format":"date-time"},"scheduled":{"type":"boolean"},"completed":{"type":"boolean"},"type":{"$ref":"#/components/schemas/AgentType"},"className":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/AgentParameter"}},"allowMultipleInstance":{"type":"boolean"},"calendar":{"$ref":"#/components/schemas/AgentCalendar"},"actor":{"$ref":"#/components/schemas/WorkeyObject"},"lastExecution":{"type":"string"},"keepHistory":{"type":"boolean"},"history":{"type":"array","items":{"$ref":"#/components/schemas/AgentHistory"}},"possibleActors":{"type":"array","items":{"$ref":"#/components/schemas/Actor"}},"possibleCalendars":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendar"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"AgentExecutionType":{"type":"string","enum":["REPEAT","CRON"]},"AgentStart":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/AgentStartMode"},"date":{"type":"string","format":"date-time"},"delay":{"type":"integer","format":"int64"}}},"AgentStartMode":{"type":"string","enum":["ASAP","COUNTDOWN","FIXED_TIME","FIXED_DATE"]},"AgentType":{"type":"string","enum":["DELAY","ROLE","CUSTOM","VIEW","ARCHIVE","SYNCHRONIZER","DELEGATIONS"]},"AgentParameter":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"select":{"type":"string"}}},"AgentCalendar":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"cronExpression":{"type":"string"},"excludedDates":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendarDate"}}}}]},"AgentCalendarDate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/AgentCalendarDateType"},"formatedDate":{"type":"string"}}},"AgentCalendarDateType":{"type":"string","enum":["ANNUAL","CRON","HOLIDAY","WEEKLY","DAILY"]},"AgentHistory":{"type":"object","properties":{"message":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"Actor":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ActorType"},"language":{"type":"string"},"manager":{"$ref":"#/components/schemas/ActorManager"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"units":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}},"delegations":{"type":"array","items":{"$ref":"#/components/schemas/Delegation"}},"availableDocuments":{"type":"array","items":{"$ref":"#/components/schemas/AvailableDocument"}}}}]},"ActorType":{"type":"string","enum":["AGENT","PERSON","UNIT","CUSTOMER"]},"ActorManager":{"type":"object","properties":{"processes":{"type":"array","items":{"$ref":"#/components/schemas/Process"}},"workflow":{"type":"boolean"},"units":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}}}},"Process":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"documentTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"active":{"type":"boolean"},"version":{"type":"integer"}}}]},"Role":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/Process"},"agent":{"type":"boolean"}}}]},"Unit":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/ActorType"},"dn":{"type":"string"},"cn":{"type":"string"},"childrenUnits":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}}}},"Delegation":{"type":"object","properties":{"role":{"$ref":"#/components/schemas/WorkeyObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"from":{"$ref":"#/components/schemas/WorkeyObject"},"processType":{"$ref":"#/components/schemas/WorkeyObject"},"delegates":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}}},"AvailableDocument":{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/WorkeyObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"role":{"$ref":"#/components/schemas/WorkeyObject"},"url":{"type":"string"}}},"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":{"/agent/{agentId}":{"get":{"summary":"Get Agent Detail","description":"Get the detail of an agent deployed on the server.\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a>","operationId":"getAgent","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"},"description":"The ``Id`` of the agent."},{"name":"history","in":"query","schema":{"type":"string"},"required":false,"description":"If this parameter is present and set to true, the \n detail of the agent will include its history."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Update Existing Agent

> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\
> \### Note\
> Only JSON input is currently supported.

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"Agent":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"executionType":{"$ref":"#/components/schemas/AgentExecutionType"},"period":{"type":"integer","format":"int64"},"cronExpression":{"type":"string"},"start":{"$ref":"#/components/schemas/AgentStart"},"nextLaunch":{"type":"string","format":"date-time"},"previousLaunch":{"type":"string","format":"date-time"},"scheduled":{"type":"boolean"},"completed":{"type":"boolean"},"type":{"$ref":"#/components/schemas/AgentType"},"className":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/AgentParameter"}},"allowMultipleInstance":{"type":"boolean"},"calendar":{"$ref":"#/components/schemas/AgentCalendar"},"actor":{"$ref":"#/components/schemas/WorkeyObject"},"lastExecution":{"type":"string"},"keepHistory":{"type":"boolean"},"history":{"type":"array","items":{"$ref":"#/components/schemas/AgentHistory"}},"possibleActors":{"type":"array","items":{"$ref":"#/components/schemas/Actor"}},"possibleCalendars":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendar"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"AgentExecutionType":{"type":"string","enum":["REPEAT","CRON"]},"AgentStart":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/AgentStartMode"},"date":{"type":"string","format":"date-time"},"delay":{"type":"integer","format":"int64"}}},"AgentStartMode":{"type":"string","enum":["ASAP","COUNTDOWN","FIXED_TIME","FIXED_DATE"]},"AgentType":{"type":"string","enum":["DELAY","ROLE","CUSTOM","VIEW","ARCHIVE","SYNCHRONIZER","DELEGATIONS"]},"AgentParameter":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"select":{"type":"string"}}},"AgentCalendar":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"cronExpression":{"type":"string"},"excludedDates":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendarDate"}}}}]},"AgentCalendarDate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/AgentCalendarDateType"},"formatedDate":{"type":"string"}}},"AgentCalendarDateType":{"type":"string","enum":["ANNUAL","CRON","HOLIDAY","WEEKLY","DAILY"]},"AgentHistory":{"type":"object","properties":{"message":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"Actor":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ActorType"},"language":{"type":"string"},"manager":{"$ref":"#/components/schemas/ActorManager"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"units":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}},"delegations":{"type":"array","items":{"$ref":"#/components/schemas/Delegation"}},"availableDocuments":{"type":"array","items":{"$ref":"#/components/schemas/AvailableDocument"}}}}]},"ActorType":{"type":"string","enum":["AGENT","PERSON","UNIT","CUSTOMER"]},"ActorManager":{"type":"object","properties":{"processes":{"type":"array","items":{"$ref":"#/components/schemas/Process"}},"workflow":{"type":"boolean"},"units":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}}}},"Process":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"documentTypes":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"active":{"type":"boolean"},"version":{"type":"integer"}}}]},"Role":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/Process"},"agent":{"type":"boolean"}}}]},"Unit":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/ActorType"},"dn":{"type":"string"},"cn":{"type":"string"},"childrenUnits":{"type":"array","items":{"$ref":"#/components/schemas/Unit"}}}},"Delegation":{"type":"object","properties":{"role":{"$ref":"#/components/schemas/WorkeyObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"from":{"$ref":"#/components/schemas/WorkeyObject"},"processType":{"$ref":"#/components/schemas/WorkeyObject"},"delegates":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"}}},"AvailableDocument":{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/WorkeyObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"role":{"$ref":"#/components/schemas/WorkeyObject"},"url":{"type":"string"}}},"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":{"/agent/{agentId}":{"put":{"summary":"Update Existing Agent","description":"<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a>\n### Note\nOnly JSON input is currently supported.","operationId":"updateAgent","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"responses":{"200":{"description":"Instance \"{instance}\" of agent #{agentId} updated."},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Remove Agent

> Remove Agent with id\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\<a href="./#wky-note-incomplete" class="wky-label wky-label-incomplete">Incomplete\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"/agent/{agentId}":{"delete":{"summary":"Remove Agent","description":"Remove Agent with id\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a><a href=\"./#wky-note-incomplete\" class=\"wky-label wky-label-incomplete\">Incomplete</a>","operationId":"removeAgent","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"},"description":"The ``Id`` of the agent."}],"responses":{"200":{"description":"Agent #{agentId} deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"500":{"description":""},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Cancel Agent Instance

> Interrupt the execution of an instance of an agent.\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"/agent/{agentId}/cancel/{instance}":{"put":{"summary":"Cancel Agent Instance","description":"Interrupt the execution of an instance of an agent.\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a>","operationId":"cancelAgentInstance","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"instance","in":"path","required":true,"schema":{"type":"string"},"description":"The key of this instance. It can be obtained by accessing the <a href=\"#get_getAgentProgress\">Get Agent Progress</a> resource."}],"responses":{"200":{"description":"Instance \"{instance}\" of agent #{agentId} cancelled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"304":{"description":"Instance \"{instance}\" of agent #{agentId} not cancelled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Clear Agent History

> Clear Agent History with id\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\<a href="./#wky-note-incomplete" class="wky-label wky-label-incomplete">Incomplete\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"/agent/{agentId}/clear":{"put":{"summary":"Clear Agent History","description":"Clear Agent History with id\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a><a href=\"./#wky-note-incomplete\" class=\"wky-label wky-label-incomplete\">Incomplete</a>","operationId":"clearAgentHistory","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"},"description":"The ``Id`` of the agent."}],"responses":{"200":{"description":"Removed {count} entries from agent #{agentId} history.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Force Agent Execution

> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\<a href="./#wky-note-incomplete" class="wky-label wky-label-incomplete">Incomplete\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"/agent/{agentId}/force":{"put":{"summary":"Force Agent Execution","description":"<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a><a href=\"./#wky-note-incomplete\" class=\"wky-label wky-label-incomplete\">Incomplete</a>","operationId":"forceAgent","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"},"description":"The ``Id`` of the agent."}],"responses":{"200":{"description":"Forced agent #{agentId} execution.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Get Agent Progress

> Get the status and progress of an agent.\
> \
> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"AgentProgress":{"type":"object","properties":{"key":{"type":"string"},"cancellable":{"type":"boolean"},"running":{"type":"boolean"},"progress":{"type":"number","format":"float"},"message":{"type":"string"},"_volatile":{"type":"boolean"}}},"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":{"/agent/{agentId}/progress":{"get":{"summary":"Get Agent Progress","description":"Get the status and progress of an agent.\n\n<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a>","operationId":"getAgentProgress","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"},"description":"The ``Id`` of the agent."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentProgress"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Schedule Agent

> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\<a href="./#wky-note-incomplete" class="wky-label wky-label-incomplete">Incomplete\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"/agent/{agentId}/schedule":{"put":{"summary":"Schedule Agent","description":"<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a><a href=\"./#wky-note-incomplete\" class=\"wky-label wky-label-incomplete\">Incomplete</a>","operationId":"scheduleAgent","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"},"description":"The ``Id`` of the agent."}],"responses":{"200":{"description":"Agent #{agentId} scheduled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```

## Unschedule Agent

> \<a href="./#wky-note-workflow-manager" class="wky-label wky-label-workflow-manager">Workflow Manager\</a>\<a href="./#wky-note-incomplete" class="wky-label wky-label-incomplete">Incomplete\</a>

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"Agent","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":{"/agent/{agentId}/unschedule":{"put":{"summary":"Unschedule Agent","description":"<a href=\"./#wky-note-workflow-manager\" class=\"wky-label wky-label-workflow-manager\">Workflow Manager</a><a href=\"./#wky-note-incomplete\" class=\"wky-label wky-label-incomplete\">Incomplete</a>","operationId":"unscheduleAgent","deprecated":false,"tags":["Agent"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"},"description":"The ``Id`` of the agent."}],"responses":{"200":{"description":"Agent #{agentId} unscheduled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"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/agent.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.