Skip to main content

CreateLinkRequest Properties

An object defining properties for the CreateLinkRequest class.

DelegationId​

Links the request to a specified delegation, allowing the link to operate based on the rights and positions associated with that delegation.

Type: long?

Status​

Indicates whether the link is active or inactive. Inactive links cannot be accessed.

Type: bool

Payload​

The JSON formatted data or plain text necessary for the specified link type.

Type: string

  • ProcessRequest
    • { "processId" : 96022, "requestId" : 312162, "requestType" : 2 }
  • FillAForm
    • { "ProjectName" : "projectName1", "FormName" : "formName1" }
    • { "ProjectName" : "projectName1", "FormName" : "formName1" "DocumentId" = 0 }
  • OpenMenuItem
    • { "MenuItemKey" : "menuItemKey1" }
  • OpenDmObject
    • { StartDownload : false, ObjSecretKey : "", Users : "1,2,3,4", Companies : "1,2,3,4" }
  • OpenMainPage
    • {}

EmbeddedView​

Indicates whether the link should hide parts of the system interface, such as the left menu and top toolbar. Typically used for displaying documents.

Type: bool

RequestLimit​

Defines the maximum number of times the link can be accessed. if is null, link is limitless.

Type: int?

LinkType​

It holds the values ​​used to specify the type of the link.

Type: CreateLinkType
Accepted Values:

NameValue
ProcessRequest0
FillAForm1
OpenMenuItem2
OpenDmObject3
OpenMainPage4
EditAForm5

ViewHideInfo​

Provides information on which sections of the interface should be hidden when the link is opened.

Type: ViewHideInfoObject

UserId​

Identifies a specific user who can access the link. If null, the link is accessible to all users.

Type: long?

ExpireDate​

Specifies the date and time when the link will expire. If null, the link remains accessible indefinitely.

Type: DateTimeOffset?

Language​

Defines the language of the link, such as en-US, tr-TR, etc.

Type: string

Scope​

Specifies the permission range that the link should adhere to.

Type: List<string>