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

# Models

## The ActorType object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"ActorType":{"type":"string","enum":["AGENT","PERSON","UNIT","CUSTOMER"]}}}}
```

## The Actor object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"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"}}}}}}
```

## The ActorData object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"ActorData":{"type":"object","properties":{"isWorkflowManager":{"type":"boolean"},"language":{"type":"string"}}}}}}
```

## The ActorPreference object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"ActorPreference":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"prefKey":{"type":"string"},"prefValue":{"type":"string"},"rank":{"type":"integer"},"actorId":{"type":"integer","format":"int64"},"version":{"type":"integer","format":"int64"},"localized":{"type":"boolean"},"selected":{"type":"boolean"}}}}}}
```

## The ActorSetting object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"ActorSetting":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"settingKey":{"type":"string"},"settingValue":{"type":"string"},"actorId":{"type":"integer","format":"int64"},"version":{"type":"integer","format":"int64"},"localized":{"type":"boolean"},"selected":{"type":"boolean"}}}}}}
```

## The AttachmentMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AttachmentMetadata":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"size":{"type":"integer","format":"int64"},"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"},"actor":{"$ref":"#/components/schemas/WorkeyObject"},"thumbnail":{"type":"boolean"}}},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The AvailableDocument object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AvailableDocument":{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/WorkeyObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"role":{"$ref":"#/components/schemas/WorkeyObject"},"url":{"type":"string"}}},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The AgentExecutionType object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AgentExecutionType":{"type":"string","enum":["REPEAT","CRON"]}}}}
```

## The AgentStartMode object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AgentStartMode":{"type":"string","enum":["ASAP","COUNTDOWN","FIXED_TIME","FIXED_DATE"]}}}}
```

## The AgentType object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AgentType":{"type":"string","enum":["DELAY","ROLE","CUSTOM","VIEW","ARCHIVE","SYNCHRONIZER","DELEGATIONS"]}}}}
```

## The Agent object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"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"}}}}}}
```

## The AgentParameter object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AgentParameter":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"},"required":{"type":"boolean"},"description":{"type":"string"},"select":{"type":"string"}}}}}}
```

## The AgentHistory object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AgentHistory":{"type":"object","properties":{"message":{"type":"string"},"date":{"type":"string","format":"date-time"}}}}}}
```

## The AgentStart object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"]}}}}
```

## The AgentCalendar object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AgentCalendar":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"cronExpression":{"type":"string"},"excludedDates":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendarDate"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"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"]}}}}
```

## The AgentCalendarDateType object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AgentCalendarDateType":{"type":"string","enum":["ANNUAL","CRON","HOLIDAY","WEEKLY","DAILY"]}}}}
```

## The AgentCalendarDate object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"]}}}}
```

## The AgentProgress object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"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"}}}}}}
```

## The Alert object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Alert":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"acknowledged":{"type":"boolean"},"acknowledgeTime":{"type":"string","format":"date-time"},"document":{"type":"integer","format":"int64"},"message":{"type":"string"},"url":{"type":"string"}}}}}}
```

## The Alerts object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Alerts":{"type":"object","properties":{}}}}}
```

## The ViewColumn object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"}}}}}}
```

## The Directory object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Directory":{"type":"object","properties":{"cn":{"type":"string"},"mail":{"type":"string"},"type":{"type":"string"},"dn":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"}}}}}}}
```

## The DirectoryNewUser object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DirectoryNewUser":{"type":"object","properties":{"login":{"type":"string"},"name":{"type":"string"},"mail":{"type":"string"},"password":{"type":"string"},"dn":{"type":"string"}}}}}}
```

## The DirectoryUpdateUser object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DirectoryUpdateUser":{"type":"object","properties":{"login":{"type":"string"},"name":{"type":"string"},"mail":{"type":"string"}}}}}}
```

## The Delegation object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"}}},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The DocumentSynchro object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentSynchro":{"type":"string","enum":["NONE","PARTIAL","ALL","OTHER"]}}}}
```

## The DocumentUserLock object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentUserLock":{"type":"string","enum":["NONE","SET","ALLOWED"]}}}}
```

## The DocumentMemoVisibility object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentMemoVisibility":{"type":"string","enum":["PUBLIC","PRIVATE"]}}}}
```

## The DocumentMemo object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentMemo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"sender":{"$ref":"#/components/schemas/WorkeyObject"},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"historyStep":{"$ref":"#/components/schemas/DocumentHistory"},"content":{"type":"string"},"date":{"type":"string","format":"date-time"},"visibility":{"$ref":"#/components/schemas/DocumentMemoVisibility"},"senderLabel":{"type":"string"},"senderUnitLabel":{"type":"string"}}},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"DocumentHistory":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"actor":{"$ref":"#/components/schemas/WorkeyObject"},"operation":{"$ref":"#/components/schemas/WorkeyObject"},"state":{"$ref":"#/components/schemas/WorkeyObject"},"unit":{"$ref":"#/components/schemas/WorkeyObject"},"originalActorLabel":{"type":"string"},"originalUnitLabel":{"type":"string"}}},"DocumentMemoVisibility":{"type":"string","enum":["PUBLIC","PRIVATE"]}}}}
```

## The DocumentInfo object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"subject":{"type":"string"},"lastAccess":{"type":"string","format":"date-time"},"updateTime":{"type":"string","format":"date-time"},"processType":{"$ref":"#/components/schemas/WorkeyVersionedObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"}}},"WorkeyVersionedObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"version":{"type":"integer"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The Document object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Document":{"allOf":[{"$ref":"#/components/schemas/DocumentInfo"},{"type":"object","properties":{"role":{"$ref":"#/components/schemas/WorkeyObject"},"userLock":{"$ref":"#/components/schemas/DocumentUserLock"},"state":{"$ref":"#/components/schemas/WorkeyObject"},"status":{"type":"string"},"form":{"$ref":"#/components/schemas/Form"},"actor":{"type":"string"},"synchro":{"$ref":"#/components/schemas/DocumentSynchro"},"postUrl":{"type":"string"},"fatherId":{"type":"integer","format":"int64"},"derivationId":{"type":"integer","format":"int64"},"isFinished":{"type":"boolean"},"isCommitable":{"type":"boolean"},"isDiscardable":{"type":"boolean"},"isOpenedByWorkflowManager":{"type":"boolean"},"isOpenedByProcessManager":{"type":"boolean"},"isOpenedByDataManager":{"type":"boolean"},"isOpenedBySupervisor":{"type":"boolean"},"isTakeInChargeAllowed":{"type":"boolean"},"isHeadOfGroup":{"type":"boolean"},"isMemoable":{"type":"boolean"},"isReleasable":{"type":"boolean"},"fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DocumentFieldBase"}},"operations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Operation"}},"history":{"type":"array","items":{"$ref":"#/components/schemas/DocumentHistory"}},"externalJSs":{"type":"array","items":{"type":"string"}},"nextActors":{"type":"array","items":{"$ref":"#/components/schemas/Actor"}},"memos":{"type":"array","items":{"$ref":"#/components/schemas/DocumentMemo"}},"nextEvents":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}}}]},"DocumentInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"subject":{"type":"string"},"lastAccess":{"type":"string","format":"date-time"},"updateTime":{"type":"string","format":"date-time"},"processType":{"$ref":"#/components/schemas/WorkeyVersionedObject"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"}}},"WorkeyVersionedObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"version":{"type":"integer"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"DocumentUserLock":{"type":"string","enum":["NONE","SET","ALLOWED"]},"Form":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"metaType":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FormItem"}},"withAttachmentPreview":{"type":"boolean"},"attachmentPreview":{"type":"string"}}},"FormItem":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"rank":{"type":"integer"},"colRank":{"type":"integer"},"textareaHeight":{"type":"integer"},"hidden":{"type":"boolean"},"readOnly":{"type":"boolean"}}}]},"DocumentSynchro":{"type":"string","enum":["NONE","PARTIAL","ALL","OTHER"]},"DocumentFieldBase":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/FieldType"},"multiple":{"type":"boolean"},"appearance":{"type":"string"},"datePattern":{"type":"string"},"select":{"type":"array","items":{"$ref":"#/components/schemas/Select"}},"min":{"type":"integer"},"max":{"type":"integer"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"hidden":{"type":"boolean"},"useThumbnail":{"type":"boolean"},"maxAttachments":{"type":"integer"},"maxTotalAttachmentsSize":{"type":"integer"},"maxAttachmentSize":{"type":"integer"}}}]},"FieldType":{"type":"string","enum":["BOOLEAN","DATE","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","BASE64BINARY","VIEW"]},"Select":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}},"Operation":{"allOf":[{"$ref":"#/components/schemas/WorkeySelectableObject"},{"type":"object","properties":{"automatic":{"type":"boolean"},"synchro":{"type":"boolean"},"optional":{"type":"boolean"},"signatureRequired":{"type":"boolean"},"signature":{"$ref":"#/components/schemas/Signature"},"states":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/State"}},"rank":{"type":"integer"}}}]},"WorkeySelectableObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"selected":{"type":"boolean"}}}]},"Signature":{"type":"object","properties":{"login":{"type":"string"},"password":{"type":"string"}}},"State":{"allOf":[{"$ref":"#/components/schemas/WorkeySelectableObject"},{"type":"object","properties":{"derivations":{"type":"array","items":{"$ref":"#/components/schemas/Derivation"}},"rule":{"type":"integer","format":"int64"},"synchro":{"type":"boolean"},"nextOperations":{"type":"array","items":{"$ref":"#/components/schemas/NextOperation"}},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"rank":{"type":"integer"}}}]},"Derivation":{"type":"object","properties":{"automatic":{"type":"boolean"},"selected":{"type":"boolean"},"required":{"type":"boolean"},"newProcess":{"type":"boolean"},"actors":{"$ref":"#/components/schemas/ActorSelection"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}}}},"ActorSelection":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"},"availableActors":{"type":"array","items":{"$ref":"#/components/schemas/WorkeySelectableObject"}}}},"Notification":{"type":"object","properties":{"selected":{"type":"boolean"},"automatic":{"type":"boolean"},"target":{"$ref":"#/components/schemas/NotificationTarget"},"subject":{"type":"string"},"editable":{"type":"boolean"},"content":{"type":"string"}}},"NotificationTarget":{"type":"string","enum":["AUTHOR","PREVIOUS","BEFORE_PREVIOUS","SUPERVISOR","SELECTED","FIELD","NEXT","NEXT_WITH_COPY_TO_USER","DELEGATION","PASSIVES","MEMO"]},"NextOperation":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"actors":{"$ref":"#/components/schemas/ActorSelection"}}}]},"DocumentHistory":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"actor":{"$ref":"#/components/schemas/WorkeyObject"},"operation":{"$ref":"#/components/schemas/WorkeyObject"},"state":{"$ref":"#/components/schemas/WorkeyObject"},"unit":{"$ref":"#/components/schemas/WorkeyObject"},"originalActorLabel":{"type":"string"},"originalUnitLabel":{"type":"string"}}},"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"}}},"DocumentMemo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"sender":{"$ref":"#/components/schemas/WorkeyObject"},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}},"historyStep":{"$ref":"#/components/schemas/DocumentHistory"},"content":{"type":"string"},"date":{"type":"string","format":"date-time"},"visibility":{"$ref":"#/components/schemas/DocumentMemoVisibility"},"senderLabel":{"type":"string"},"senderUnitLabel":{"type":"string"}}},"DocumentMemoVisibility":{"type":"string","enum":["PUBLIC","PRIVATE"]},"Event":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"nextOccurrenceTimeFormatted":{"type":"string"},"finalOccurenceTimeFormatted":{"type":"string"},"operationName":{"type":"string"}}}]}}}}
```

## The DocumentHistory object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentHistory":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"actor":{"$ref":"#/components/schemas/WorkeyObject"},"operation":{"$ref":"#/components/schemas/WorkeyObject"},"state":{"$ref":"#/components/schemas/WorkeyObject"},"unit":{"$ref":"#/components/schemas/WorkeyObject"},"originalActorLabel":{"type":"string"},"originalUnitLabel":{"type":"string"}}},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The DocumentType object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentType":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTypeField"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"DocumentTypeField":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FieldType"},"multiple":{"type":"boolean"},"appearance":{"type":"string"}}}]},"FieldType":{"type":"string","enum":["BOOLEAN","DATE","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","BASE64BINARY","VIEW"]}}}}
```

## The DocumentTypeOperations object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentTypeOperations":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTypeOperation"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"DocumentTypeOperation":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"role":{"$ref":"#/components/schemas/WorkeyObject"}}}]}}}}
```

## The DocumentTypeOperation object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentTypeOperation":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"role":{"$ref":"#/components/schemas/WorkeyObject"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The DocumentRoleSelection object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentRoleSelection":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"documentLink":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The DocumentDataHistory object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentDataHistory":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"rank":{"type":"integer"},"value":{"type":"string"},"operationDate":{"type":"string","format":"date-time"},"documentId":{"type":"integer","format":"int64"},"documentFieldId":{"type":"integer","format":"int64"}}}}}}
```

## The DocumentFieldHistory object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentFieldHistory":{"type":"object","properties":{"documentData":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DocumentDataHistory"}},"documentHistory":{"$ref":"#/components/schemas/DocumentHistory"}}},"DocumentDataHistory":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"rank":{"type":"integer"},"value":{"type":"string"},"operationDate":{"type":"string","format":"date-time"},"documentId":{"type":"integer","format":"int64"},"documentFieldId":{"type":"integer","format":"int64"}}},"DocumentHistory":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"actor":{"$ref":"#/components/schemas/WorkeyObject"},"operation":{"$ref":"#/components/schemas/WorkeyObject"},"state":{"$ref":"#/components/schemas/WorkeyObject"},"unit":{"$ref":"#/components/schemas/WorkeyObject"},"originalActorLabel":{"type":"string"},"originalUnitLabel":{"type":"string"}}},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The Event object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Event":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"nextOccurrenceTimeFormatted":{"type":"string"},"finalOccurenceTimeFormatted":{"type":"string"},"operationName":{"type":"string"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The NotificationTarget object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"NotificationTarget":{"type":"string","enum":["AUTHOR","PREVIOUS","BEFORE_PREVIOUS","SUPERVISOR","SELECTED","FIELD","NEXT","NEXT_WITH_COPY_TO_USER","DELEGATION","PASSIVES","MEMO"]}}}}
```

## The Notification object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Notification":{"type":"object","properties":{"selected":{"type":"boolean"},"automatic":{"type":"boolean"},"target":{"$ref":"#/components/schemas/NotificationTarget"},"subject":{"type":"string"},"editable":{"type":"boolean"},"content":{"type":"string"}}},"NotificationTarget":{"type":"string","enum":["AUTHOR","PREVIOUS","BEFORE_PREVIOUS","SUPERVISOR","SELECTED","FIELD","NEXT","NEXT_WITH_COPY_TO_USER","DELEGATION","PASSIVES","MEMO"]}}}}
```

## The FieldType object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"FieldType":{"type":"string","enum":["BOOLEAN","DATE","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","BASE64BINARY","VIEW"]}}}}
```

## The DocumentTypeField object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentTypeField":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FieldType"},"multiple":{"type":"boolean"},"appearance":{"type":"string"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"FieldType":{"type":"string","enum":["BOOLEAN","DATE","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","BASE64BINARY","VIEW"]}}}}
```

## The DocumentFieldBase object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentFieldBase":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/FieldType"},"multiple":{"type":"boolean"},"appearance":{"type":"string"},"datePattern":{"type":"string"},"select":{"type":"array","items":{"$ref":"#/components/schemas/Select"}},"min":{"type":"integer"},"max":{"type":"integer"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"hidden":{"type":"boolean"},"useThumbnail":{"type":"boolean"},"maxAttachments":{"type":"integer"},"maxTotalAttachmentsSize":{"type":"integer"},"maxAttachmentSize":{"type":"integer"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"FieldType":{"type":"string","enum":["BOOLEAN","DATE","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","BASE64BINARY","VIEW"]},"Select":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The DocumentFieldStandard object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentFieldStandard":{"allOf":[{"$ref":"#/components/schemas/DocumentFieldBase"},{"type":"object","properties":{}}]},"DocumentFieldBase":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/FieldType"},"multiple":{"type":"boolean"},"appearance":{"type":"string"},"datePattern":{"type":"string"},"select":{"type":"array","items":{"$ref":"#/components/schemas/Select"}},"min":{"type":"integer"},"max":{"type":"integer"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"hidden":{"type":"boolean"},"useThumbnail":{"type":"boolean"},"maxAttachments":{"type":"integer"},"maxTotalAttachmentsSize":{"type":"integer"},"maxAttachmentSize":{"type":"integer"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"FieldType":{"type":"string","enum":["BOOLEAN","DATE","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","BASE64BINARY","VIEW"]},"Select":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The DocumentFieldEmbeddedView object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocumentFieldEmbeddedView":{"allOf":[{"$ref":"#/components/schemas/DocumentFieldBase"},{"type":"object","properties":{"viewUrl":{"type":"string"},"creationUrl":{"type":"string"},"create":{"type":"boolean"}}}]},"DocumentFieldBase":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/FieldType"},"multiple":{"type":"boolean"},"appearance":{"type":"string"},"datePattern":{"type":"string"},"select":{"type":"array","items":{"$ref":"#/components/schemas/Select"}},"min":{"type":"integer"},"max":{"type":"integer"},"required":{"type":"boolean"},"readOnly":{"type":"boolean"},"hidden":{"type":"boolean"},"useThumbnail":{"type":"boolean"},"maxAttachments":{"type":"integer"},"maxTotalAttachmentsSize":{"type":"integer"},"maxAttachmentSize":{"type":"integer"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"FieldType":{"type":"string","enum":["BOOLEAN","DATE","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","BASE64BINARY","VIEW"]},"Select":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The Form object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Form":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"metaType":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FormItem"}},"withAttachmentPreview":{"type":"boolean"},"attachmentPreview":{"type":"string"}}},"FormItem":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"rank":{"type":"integer"},"colRank":{"type":"integer"},"textareaHeight":{"type":"integer"},"hidden":{"type":"boolean"},"readOnly":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The FormItem object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"FormItem":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"rank":{"type":"integer"},"colRank":{"type":"integer"},"textareaHeight":{"type":"integer"},"hidden":{"type":"boolean"},"readOnly":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The FormItemTable object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"FormItemTable":{"allOf":[{"$ref":"#/components/schemas/FormItem"},{"type":"object","properties":{"nbCols":{"type":"integer"},"dynamic":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FormItem"}},"colSizes":{"type":"string"},"displayMode":{"type":"integer"},"autoRefresh":{"type":"boolean"},"customFieldConfig":{"type":"string"}}}]},"FormItem":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"rank":{"type":"integer"},"colRank":{"type":"integer"},"textareaHeight":{"type":"integer"},"hidden":{"type":"boolean"},"readOnly":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The FormItemSection object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"FormItemSection":{"allOf":[{"$ref":"#/components/schemas/FormItem"},{"type":"object","properties":{"collapsed":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FormItem"}}}}]},"FormItem":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"rank":{"type":"integer"},"colRank":{"type":"integer"},"textareaHeight":{"type":"integer"},"hidden":{"type":"boolean"},"readOnly":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The FormItemField object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"FormItemField":{"allOf":[{"$ref":"#/components/schemas/FormItem"},{"type":"object","properties":{"useThumbnail":{"type":"boolean"},"type":{"type":"string"},"appearance":{"type":"string"},"required":{"type":"boolean"},"rows":{"type":"integer"},"cols":{"type":"integer"},"multiple":{"type":"boolean"},"maxSize":{"type":"integer"},"max":{"type":"integer"},"min":{"type":"integer"},"datePattern":{"type":"string"},"numberPattern":{"type":"string"},"select":{"type":"array","items":{"$ref":"#/components/schemas/Select"}},"values":{"type":"array","items":{"type":"string"}},"maxAttachments":{"type":"integer"},"maxTotalAttachmentsSize":{"type":"integer"},"maxAttachmentSize":{"type":"integer"},"customFieldConfig":{"type":"string"}}}]},"FormItem":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"rank":{"type":"integer"},"colRank":{"type":"integer"},"textareaHeight":{"type":"integer"},"hidden":{"type":"boolean"},"readOnly":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"Select":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The FormItemEmbedded object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"FormItemEmbedded":{"allOf":[{"$ref":"#/components/schemas/FormItem"},{"type":"object","properties":{"viewId":{"type":"integer","format":"int64"},"derivable":{"type":"boolean"},"documentId":{"type":"integer","format":"int64"},"derivationAllowed":{"type":"boolean"},"viewUrl":{"type":"string"},"creationUrl":{"type":"string"}}}]},"FormItem":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"rank":{"type":"integer"},"colRank":{"type":"integer"},"textareaHeight":{"type":"integer"},"hidden":{"type":"boolean"},"readOnly":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The Hit object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Hit":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}}}}
```

## The License object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"License":{"type":"object","properties":{"product":{"type":"string"},"licensee":{"type":"string"},"allowedProcesses":{"type":"integer"},"allowedUsers":{"type":"integer"},"allowedSessions":{"type":"integer"},"expirationDate":{"type":"string","format":"date-time"},"hasReporting":{"type":"boolean"},"hasArchiving":{"type":"boolean"},"currentProcesses":{"type":"integer"},"currentUsers":{"type":"integer"},"currentSessions":{"type":"integer"}}}}}}
```

## The ActorManager object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"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"}}}},"ActorType":{"type":"string","enum":["AGENT","PERSON","UNIT","CUSTOMER"]}}}}
```

## The Version object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Version":{"type":"object","properties":{"version":{"type":"string"},"tag":{"type":"string"},"major":{"type":"integer"}}}}}}
```

## The MessageType object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"MessageType":{"type":"string","enum":["ALERT","INFO","WARNING"]}}}}
```

## The MessageTarget object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"MessageTarget":{"type":"string","enum":["ALL","GLOBAL","PROCESS","UNIT","ACTOR"]}}}}
```

## The Message object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Message":{"type":"object","properties":{"expires":{"type":"integer","format":"int64"},"id":{"type":"integer","format":"int64"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/MessageType"},"target":{"$ref":"#/components/schemas/MessageTarget"}}},"MessageType":{"type":"string","enum":["ALERT","INFO","WARNING"]},"MessageTarget":{"type":"string","enum":["ALL","GLOBAL","PROCESS","UNIT","ACTOR"]}}}}
```

## The Signature object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Signature":{"type":"object","properties":{"login":{"type":"string"},"password":{"type":"string"}}}}}}
```

## The Operation object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Operation":{"allOf":[{"$ref":"#/components/schemas/WorkeySelectableObject"},{"type":"object","properties":{"automatic":{"type":"boolean"},"synchro":{"type":"boolean"},"optional":{"type":"boolean"},"signatureRequired":{"type":"boolean"},"signature":{"$ref":"#/components/schemas/Signature"},"states":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/State"}},"rank":{"type":"integer"}}}]},"WorkeySelectableObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"selected":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"Signature":{"type":"object","properties":{"login":{"type":"string"},"password":{"type":"string"}}},"State":{"allOf":[{"$ref":"#/components/schemas/WorkeySelectableObject"},{"type":"object","properties":{"derivations":{"type":"array","items":{"$ref":"#/components/schemas/Derivation"}},"rule":{"type":"integer","format":"int64"},"synchro":{"type":"boolean"},"nextOperations":{"type":"array","items":{"$ref":"#/components/schemas/NextOperation"}},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"rank":{"type":"integer"}}}]},"Derivation":{"type":"object","properties":{"automatic":{"type":"boolean"},"selected":{"type":"boolean"},"required":{"type":"boolean"},"newProcess":{"type":"boolean"},"actors":{"$ref":"#/components/schemas/ActorSelection"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}}}},"ActorSelection":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"},"availableActors":{"type":"array","items":{"$ref":"#/components/schemas/WorkeySelectableObject"}}}},"Notification":{"type":"object","properties":{"selected":{"type":"boolean"},"automatic":{"type":"boolean"},"target":{"$ref":"#/components/schemas/NotificationTarget"},"subject":{"type":"string"},"editable":{"type":"boolean"},"content":{"type":"string"}}},"NotificationTarget":{"type":"string","enum":["AUTHOR","PREVIOUS","BEFORE_PREVIOUS","SUPERVISOR","SELECTED","FIELD","NEXT","NEXT_WITH_COPY_TO_USER","DELEGATION","PASSIVES","MEMO"]},"NextOperation":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"actors":{"$ref":"#/components/schemas/ActorSelection"}}}]}}}}
```

## The Process object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"Role":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/Process"},"agent":{"type":"boolean"}}}]}}}}
```

## The Role object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Role":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"processType":{"$ref":"#/components/schemas/Process"},"agent":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"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"}}}]}}}}
```

## The RolesOperations object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"RolesOperations":{"type":"object","properties":{"roleOperation":{"type":"array","items":{"$ref":"#/components/schemas/RoleOperations"}}}},"RoleOperations":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The RoleOperations object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"RoleOperations":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/WorkeyObject"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The ViewRow object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"}}}}}}
```

## The RowDocument object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"RowDocument":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"documentTypeId":{"type":"integer"},"processTypeId":{"type":"integer"},"documentTypeName":{"type":"string"},"processTypeName":{"type":"string"}}}}}}
```

## The SearchResult object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"SearchResult":{"type":"object","properties":{"size":{"type":"integer"},"columns":{"type":"object","additionalProperties":{"type":"string"}},"hits":{"type":"array","items":{"type":"list"}}}}}}}
```

## The SearchResults object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"SearchResults":{"type":"object","properties":{}}}}}
```

## The SearchItem object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"SearchItem":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"}}}}}}
```

## The SearchField object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"SearchField":{"allOf":[{"$ref":"#/components/schemas/SearchItem"},{"type":"object","properties":{}}]},"SearchItem":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"}}}}}}
```

## The SearchHelper object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"SearchHelper":{"type":"object","properties":{"processes":{"type":"array","items":{"$ref":"#/components/schemas/SearchProcess"}},"fields":{"type":"object","additionalProperties":{"type":"string"}}}},"SearchProcess":{"allOf":[{"$ref":"#/components/schemas/SearchItem"},{"type":"object","properties":{"doctypes":{"type":"array","items":{"$ref":"#/components/schemas/SearchDocumentType"}}}}]},"SearchItem":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"}}},"SearchDocumentType":{"allOf":[{"$ref":"#/components/schemas/SearchItem"},{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/SearchField"}},"states":{"type":"array","items":{"$ref":"#/components/schemas/SearchItem"}}}}]},"SearchField":{"allOf":[{"$ref":"#/components/schemas/SearchItem"},{"type":"object","properties":{}}]}}}}
```

## The SearchProcess object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"SearchProcess":{"allOf":[{"$ref":"#/components/schemas/SearchItem"},{"type":"object","properties":{"doctypes":{"type":"array","items":{"$ref":"#/components/schemas/SearchDocumentType"}}}}]},"SearchItem":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"}}},"SearchDocumentType":{"allOf":[{"$ref":"#/components/schemas/SearchItem"},{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/SearchField"}},"states":{"type":"array","items":{"$ref":"#/components/schemas/SearchItem"}}}}]},"SearchField":{"allOf":[{"$ref":"#/components/schemas/SearchItem"},{"type":"object","properties":{}}]}}}}
```

## The SearchDocumentType object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"SearchDocumentType":{"allOf":[{"$ref":"#/components/schemas/SearchItem"},{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/SearchField"}},"states":{"type":"array","items":{"$ref":"#/components/schemas/SearchItem"}}}}]},"SearchItem":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"}}},"SearchField":{"allOf":[{"$ref":"#/components/schemas/SearchItem"},{"type":"object","properties":{}}]}}}}
```

## The Select object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Select":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The ServerConfig object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"ServerConfig":{"type":"object","properties":{}}}}}
```

## The State object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"State":{"allOf":[{"$ref":"#/components/schemas/WorkeySelectableObject"},{"type":"object","properties":{"derivations":{"type":"array","items":{"$ref":"#/components/schemas/Derivation"}},"rule":{"type":"integer","format":"int64"},"synchro":{"type":"boolean"},"nextOperations":{"type":"array","items":{"$ref":"#/components/schemas/NextOperation"}},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"rank":{"type":"integer"}}}]},"WorkeySelectableObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"selected":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"Derivation":{"type":"object","properties":{"automatic":{"type":"boolean"},"selected":{"type":"boolean"},"required":{"type":"boolean"},"newProcess":{"type":"boolean"},"actors":{"$ref":"#/components/schemas/ActorSelection"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}}}},"ActorSelection":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"},"availableActors":{"type":"array","items":{"$ref":"#/components/schemas/WorkeySelectableObject"}}}},"Notification":{"type":"object","properties":{"selected":{"type":"boolean"},"automatic":{"type":"boolean"},"target":{"$ref":"#/components/schemas/NotificationTarget"},"subject":{"type":"string"},"editable":{"type":"boolean"},"content":{"type":"string"}}},"NotificationTarget":{"type":"string","enum":["AUTHOR","PREVIOUS","BEFORE_PREVIOUS","SUPERVISOR","SELECTED","FIELD","NEXT","NEXT_WITH_COPY_TO_USER","DELEGATION","PASSIVES","MEMO"]},"NextOperation":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"actors":{"$ref":"#/components/schemas/ActorSelection"}}}]}}}}
```

## The NextOperation object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"NextOperation":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"actors":{"$ref":"#/components/schemas/ActorSelection"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"ActorSelection":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"},"availableActors":{"type":"array","items":{"$ref":"#/components/schemas/WorkeySelectableObject"}}}},"WorkeySelectableObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"selected":{"type":"boolean"}}}]}}}}
```

## The DelegationHelper object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DelegationHelper":{"type":"object","properties":{"rolesByProcess":{"type":"array","items":{"$ref":"#/components/schemas/DelegationProcess"}},"actorsByRole":{"type":"array","items":{"$ref":"#/components/schemas/DelegationRole"}},"actors":{"type":"array","items":{"$ref":"#/components/schemas/DelegationActor"}}}},"DelegationProcess":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"userRoles":{"type":"array","items":{"$ref":"#/components/schemas/DelegationRole"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"DelegationRole":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"actors":{"type":"array","items":{"$ref":"#/components/schemas/DelegationActor"}}}}]},"DelegationActor":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{}}]}}}}
```

## The DelegationProcess object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DelegationProcess":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"userRoles":{"type":"array","items":{"$ref":"#/components/schemas/DelegationRole"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"DelegationRole":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"actors":{"type":"array","items":{"$ref":"#/components/schemas/DelegationActor"}}}}]},"DelegationActor":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{}}]}}}}
```

## The DelegationRole object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DelegationRole":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"actors":{"type":"array","items":{"$ref":"#/components/schemas/DelegationActor"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"DelegationActor":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{}}]}}}}
```

## The DelegationActor object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DelegationActor":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The ActorSelection object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"ActorSelection":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"},"availableActors":{"type":"array","items":{"$ref":"#/components/schemas/WorkeySelectableObject"}}}},"WorkeySelectableObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"selected":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The Derivation object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Derivation":{"type":"object","properties":{"automatic":{"type":"boolean"},"selected":{"type":"boolean"},"required":{"type":"boolean"},"newProcess":{"type":"boolean"},"actors":{"$ref":"#/components/schemas/ActorSelection"},"documentType":{"$ref":"#/components/schemas/WorkeyObject"},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}}}},"ActorSelection":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"},"availableActors":{"type":"array","items":{"$ref":"#/components/schemas/WorkeySelectableObject"}}}},"WorkeySelectableObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"selected":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"Notification":{"type":"object","properties":{"selected":{"type":"boolean"},"automatic":{"type":"boolean"},"target":{"$ref":"#/components/schemas/NotificationTarget"},"subject":{"type":"string"},"editable":{"type":"boolean"},"content":{"type":"string"}}},"NotificationTarget":{"type":"string","enum":["AUTHOR","PREVIOUS","BEFORE_PREVIOUS","SUPERVISOR","SELECTED","FIELD","NEXT","NEXT_WITH_COPY_TO_USER","DELEGATION","PASSIVES","MEMO"]}}}}
```

## The Unit object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"}}}},"ActorType":{"type":"string","enum":["AGENT","PERSON","UNIT","CUSTOMER"]}}}}
```

## The Relation object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Relation":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The ViewAction object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"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"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The View object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"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"}}}}]}}}}
```

## The WorkeyObject object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The WorkeyVersionedObject object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"WorkeyVersionedObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"version":{"type":"integer"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The WorkeySelectableObject object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"WorkeySelectableObject":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"selected":{"type":"boolean"}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The RestMessage object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"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"}}}}}}
```

## The ErrorCause object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}}}}
```

## The CompilationErrorsOutput object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"CompilationErrorsOutput":{"type":"object","properties":{"codificationId":{"type":"string"},"source":{"type":"string"},"message":{"type":"string"}}}}}}
```

## The CustomSearch object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"CustomSearch":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"searchTitle":{"type":"string"},"text":{"type":"string"},"subject":{"type":"string"},"searchFieldName":{"type":"string"},"searchFieldOp":{"type":"string"},"searchFieldValue":{"type":"string"},"processes":{"type":"string"},"doctypes":{"type":"string"},"states":{"type":"string"},"columns":{"type":"string"},"creationDateStart":{"type":"string"},"creationDateEnd":{"type":"string"},"query":{"type":"string"}}}}}}
```

## The NoSchema object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"NoSchema":{"type":"object","properties":{}}}}}
```

## The ViewActionResult object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"ViewActionResult":{"type":"object","properties":{"type":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"response":{"type":"string"}}}}}}
```

## The AuthCredentials object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AuthCredentials":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}}}}}
```

## The AuthToken object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AuthToken":{"type":"object","properties":{"token":{"type":"string"},"refreshToken":{"type":"string"}}}}}}
```

## The AuthRefreshToken object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AuthRefreshToken":{"type":"object","properties":{"refreshToken":{"type":"string"}}}}}}
```

## The Mappings object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Mappings":{"type":"object","properties":{"mappings":{"type":"array","items":{"$ref":"#/components/schemas/Mapping"}}}},"Mapping":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/DocItem"},"process":{"$ref":"#/components/schemas/MgxItem"},"documentField":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/FieldMapping"}}}},"DocItem":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"metaType":{"type":"string"}}},"MgxItem":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}},"FieldMapping":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Item"},"target":{"$ref":"#/components/schemas/Item"},"type":{"type":"string"}}},"Item":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}}}}
```

## The Mapping object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Mapping":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/DocItem"},"process":{"$ref":"#/components/schemas/MgxItem"},"documentField":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/FieldMapping"}}}},"DocItem":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"metaType":{"type":"string"}}},"MgxItem":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}},"FieldMapping":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Item"},"target":{"$ref":"#/components/schemas/Item"},"type":{"type":"string"}}},"Item":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}}}}
```

## The MgxDocTemplate object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"MgxDocTemplate":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"processes":{"type":"array","items":{"$ref":"#/components/schemas/MgxItem"}}}},"MgxItem":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}}}}
```

## The FieldMapping object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"FieldMapping":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Item"},"target":{"$ref":"#/components/schemas/Item"},"type":{"type":"string"}}},"Item":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}}}}
```

## The DocItem object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"DocItem":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"metaType":{"type":"string"}}}}}}
```

## The Item object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"Item":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}}}}
```

## The MgxItem object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"MgxItem":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}}}}
```

## The AttachmentUpload object

```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"components":{"schemas":{"AttachmentUpload":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}
```


---

# 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/models.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.