Table of Contents

Interface CommandParamsEntity

Parameters used for commands which need an entity ID or a list-reference.
⤴️ back to All Command Names

Package: Api.Js.SxcJs

Properties

entityId

ID of item to edit.

Declaration
entityId: number
Property Value
Type Description
number

fields

Parent Entity field(s) name(s). Usually just one field, like Authors. In field-sets it could be Author,Award or similar.

Declaration
fields: string
Property Value
Type Description
string

index

Determins the position of the item in the list. index was added in v14.04 to replace the sortOrder which had a confusing name.

Declaration
index: number
Property Value
Type Description
number

parent

Parent entity GUID which has the field referencing this item.

Declaration
parent: string
Property Value
Type Description
string

useModuleList

Must be true, to work on the module list.

Declaration
useModuleList: true
Property Value
Type Description
true