@dvelop-sdk
    Preparing search index...

    Interface CreateTaskParams

    Parameters for the createTask-function.

    interface CreateTaskParams {
        _links?: {
            attachment?: { href: string };
            callback?: { href: string };
            changeCallback?: { href: string };
            form?: { href: string };
            process?: { href: string };
        };
        actionScopes?: {
            claim?: ("details" | "list")[];
            complete?: ("details" | "list")[];
            forward?: ("details" | "list")[];
        };
        assignees: string[];
        context?: { key?: string; name?: string; type?: string };
        correlationKey?: string;
        description?: string;
        dmsObject?: { dmsObjectId: string; repositoryId: string };
        dueDate?: Date;
        metadata?: {
            caption?: string;
            key?: string;
            type?: "String" | "Number" | "Money" | "Date";
            values?: string;
        }[];
        priority?: number;
        reminderDate?: Date;
        retentionTime?: string;
        sendCompletionNotification?: boolean;
        sendCreationNotification?: boolean;
        sendDueDateNotification?: boolean;
        subject: string;
    }
    Index

    Properties

    _links? actionScopes? assignees context? correlationKey? description? dmsObject? dueDate? metadata? priority? reminderDate? retentionTime? sendCompletionNotification? sendCreationNotification? sendDueDateNotification? subject

    Properties

    Optional_links

    _links?: {
        attachment?: { href: string };
        callback?: { href: string };
        changeCallback?: { href: string };
        form?: { href: string };
        process?: { href: string };
    }

    Links to the task

    Type Declaration

    • Optionalattachment?: { href: string }

      This URI is displayed as an action in the user interface to display additional information for the user.

    • Optionalcallback?: { href: string }

      This URI is called on completion of a task via the method POST.

    • OptionalchangeCallback?: { href: string }

      This URI is called in case of updates to the task via the method POST.

    • Optionalform?: { href: string }

      This URI provides an editing dialog for the task. You can find further details in the section Adding editing dialogs.

    • Optionalprocess?: { href: string }

      This URI represents the process by which the task was initiated. The process is displayed in the user interface as a separate perspective for the task. To display completed tasks, the resource has to implement a HEAD request, if the resource is behind the same base address.

    actionScopes?: {
        claim?: ("details" | "list")[];
        complete?: ("details" | "list")[];
        forward?: ("details" | "list")[];
    }

    Configuration of actions in the user interface

    Type Declaration

    • Optionalclaim?: ("details" | "list")[]

      Context for claim button. Possible values are "list" & "details"

    • Optionalcomplete?: ("details" | "list")[]

      Context for complete button. Possible values are "list" & "details"

    • Optionalforward?: ("details" | "list")[]

      Context for forward button. Possible values are "list" & "details"

    assignees: string[]

    The recipients of the task. You can specify individual users as well as groups using IDs of the Identityprovider-App

    context?: { key?: string; name?: string; type?: string }

    The context of a task

    Type Declaration

    • Optionalkey?: string

      A technical identifier for the context

    • Optionalname?: string

      Display name of the context

    • Optionaltype?: string

      Type of the context

    correlationKey?: string

    The correlation key ensures that only one task is created for this unique key. If a task already exists with the passed key, a new task will not be created.

    description?: string

    A descriptive text of the task

    dmsObject?: { dmsObjectId: string; repositoryId: string }

    DmsObject that references the task.

    Type Declaration

    • dmsObjectId: string

      ID of the DmsObject

    • repositoryId: string

      ID of the repository

    dueDate?: Date

    Due date of the task. If you transfer a date without a timestamp, the due date is the transferred date at 00:00:00.

    metadata?: {
        caption?: string;
        key?: string;
        type?: "String" | "Number" | "Money" | "Date";
        values?: string;
    }[]

    Metadata for the task. See the documentation for further information

    Type Declaration

    • Optionalcaption?: string

      Label of the metadata-field

    • Optionalkey?: string

      A technical identifier for the metadata-field

    • Optionaltype?: "String" | "Number" | "Money" | "Date"

      Type of the metadata-field

    • Optionalvalues?: string

      Value of the metadata field. Currently, only one value is allowed per metadata-field.

    priority?: number

    Priority between 0 (low) and 100 (high)

    reminderDate?: Date

    Reminder date. If you transfer a date without a timestamp, the reminder date is the transferred date at 00:00:00.

    retentionTime?: string

    Specify how long the task details should be kept after completing the task. Valid values are between 0 and 365 days. After this time has passed, the task details will be deleted automatically. The information is specified as a time span in days according to ISO-8601, e.g. P30D for 30 days. Specify the time span P0D if the task details should be deleted immediately after the task is completed. If you make no specification, 30 days are automatically assumed.

    sendCompletionNotification?: boolean

    Specifies if a notification should be sent to the task creator when the task is completed. Default is false.

    sendCreationNotification?: boolean

    Specifies if a notification should be sent to the task creator when the task is created. Default is true.

    sendDueDateNotification?: boolean

    Specifies if a notification should be sent to the task creator when the due date is exceeded. This option is only available if a dueDate is specified. Default is false.

    subject: string

    The subject of the task

    Settings

    Member Visibility

    On This Page

    Properties