/
Actions API documentation

Actions API documentation

Owned by Samuel Palaj
08.10.2021
3 min read

This document contains information about structure of requests and responses used by actions API as of NAE version 5.7.0.

Requests

todo

Petri net requests

Case requests

Task requests

Data requests

Responses

Response attributes

EventOutcome

{ message?: string, outcomes?: EventOutcome[] }

PetriNetReference

{ stringId: string, title: string, identifier: string, version: string, initials: string, defaultCaseName: string, createdDate: NaeDate, author: Author, immediateData: Array<ImmediateData> }

NaeDate

[year month day hour minute second timestamp]

Author

{ email: string, fullName: string }

ImmediateData

{ stringId: string, title: string, type: string }

Case

{ lastModified: NaeDate, visualId: string, petriNetObjectId: PetriNetObjectId, processIdentifier: string, title: string, color: string, icon: string, creationDate: NaeDate, immediateData: Array<ImmediateData>, author: Author, viewRoles: Array<string>, permissions: Permissions, negativeViewRoles: ?, users: UsersPermissions, userRefs: ?, negativeViewUsers: ?, stringId: string, petriNetId: string, viewUserRefs: ? }

PetriNetObjectId

{ timestamp: number, machineIdentifier: number, processIdentifier: number, counter: number, timeSecond: number, time: number, date: number, }

Permission

{ create?: boolean, delete?: boolean, view?: boolean }

Permissions

{ [k: string]: Permission }

UserPermissions

{ [k: number]: Permission }

Task

{ caseId: string, transitionId: string, layout: TaskLayout, title: string, caseColor: string, caseTitle: string, priority: number, user: UserResourceSmall, roles: object, users: UsersRef, startDate: NaeDate, finishDate: NaeDate, finishedBy: number, transactionId: string, requiredFilled: boolean, immediateData: Array<ImmediateData>, icon: string, assignPolicy: string, dataFocusPolicy: string, finishPolicy: string, finishTitle: string, cancelTitle: string, delegateTitle: string, assignTitle: string, assignedUserPolicy: AssignedUserPolicy, }

BasicLayout

{ rows: number, cols: number }

TaskLayout

  • extends BasicLayout

{ offset: number, type?: DataGroupLayoutType, fieldAlignment?: FieldAlignment, hideEmptyRows?: DataGroupHideEmptyRows, compactDirection?: DataGroupCompact, [k: string]: any }

DataGroupLayoutType

  • enum

{ GRID = 'grid', FLOW = 'flow', LEGACY = 'legacy' }

FieldAllignment

  • enum

{ TOP = 'top', CENTER = 'center', BOTTOM = 'bottom' }

DataGroupHideEmptyRows

  • enum

{ ALL = 'all', COMPACTED = 'compacted', NONE = 'none', }

DataGroupCompact

  • enum

{ NONE = 'none', UP = 'up', }

IUser

{ id: string, email: string, name: string, surname: string }

UserResourceSmall

  • extends IUser

{ fullName: string, avatar?: string, }

UsersRef

{ [k: number]: { [k: string]: boolean } }

AssignedUserPolicy

{ cancel?: boolean, reassign?: boolean }

ChangedFieldContainer

{ changedFields: ChangedFields }

ChangedFields

{ [key: string]: Change | any }

Change

{ value?: string | number | boolean | any, type?: string, behavior?: { [key: string]: Behavior }; [key: string]: any; }

Behavior

{ required?: boolean, optional?: boolean, visible?: boolean, editable?: boolean, hidden?: boolean, forbidden?: boolean, }

DataGroup

{ fields: Array<DataField<any>>, title: string, alignment: DataGroupAlignment, stretch: boolean, layout?: DataGroupLayout, parentTaskId?: string, parentCaseId?: string, }

DataGroupLayout

{ type: DataGroupLayoutType, hideEmptyRows?: DataGroupHideEmptyRows, compactDirection?: DataGroupCompact, [k: string]: any }

DataGroupAlignment

  • enum

{ START = 'start', CENTER = 'center', END = 'end' }

DataField

{ stringId: string, type: string, name: string, description: string, placeholder: string, behavior: Behavior, layout: Layout, value: any?, order: number, view: string, length: number, component: Component, validations: Array<Validation>, parentTaskId: string, parentCaseId: string, }

Validation

{ validationRule: string, validationMessage: string }

Component

{ name: string, properties?: Properties, optionIcons?: Array<Icon> }

GridLayout

  • extends BasicLayout

{ x: number, y: number }

Layout

  • extends GridLayout

{ template: TemplateAppearance, appearance: MaterialAppearance, offset: number, alignment?: FieldAlignment }

TemplateAppearance

  • enum

{ MATERIAL = 'material', NETGRIF = 'netgrif', }

MaterialAppearance

{ LEGACY = 'legacy', STANDARD = 'standard', FILL = 'fill', OUTLINE = 'outline' }

FieldAlignment

{ TOP = 'top', CENTER = 'center', BOTTOM = 'bottom' }

Icon

{ key: string; type: string; value: string; }

Properties

{ [key: string]: any }

Base response types

MessageResource

{ error?: string, links?: Link, success?: string; }

EventOutcomeMessageResource

  • extends MessageResource

{ outcome?: EventOutcome }


Petri net responses

PetriNetEventOutcome

  • extends EventOutcome

{ net: PetriNetReference }

ImportPetriNetEventOutcome

  • extends PetriNetEventOutcome

{}

Case responses

CaseEventOutcome

  • extends PetriNetEventOutcome

{ aCase: Case; }

CreateCaseEventOutcome

  • extends CaseEventOutcome

{}

DeleteCaseEventOutcome

  • extends CaseEventOutcome

{}

Task responses

TaskEventOutcome

  • extends CaseEventOutcome

{ task?: Task; }

AssignTaskEventOutcome

  • extends TaskEventOutcome

{}

CancelTaskEventOutcome

  • extends TaskEventOutcome

{}

 

FinishTaskEventOutcome

  • extends TaskEventOutcome

{}

 

DelegateTaskEventOutcome

  • extends TaskEventOutcome

{}

Data responses

GetDataGroupsEventOutcome

  • extends TaskEventOutcome

{ data: DataGroup[]; }

SetDataEventOutcome

  • extends TaskEventOutcome

{ changedFields: ChangedFieldContainer; }

Related content