@dvelop-sdk
    Preparing search index...

    Interface Task

    Response for the getTask-function.

    interface Task {
        _links?: {
            attachment?: { href: string };
            form?: { href: string };
            self: { href: string };
        };
        assignees: string[];
        completionDate?: Date;
        completionUser?: string;
        context?: { key?: string; name?: string; type?: string };
        correlationKey?: string;
        description?: string;
        dmsReferences?: { objectId: string; repoId: string }[];
        dueDate?: Date;
        id: string;
        metadata?: {
            caption?: string;
            key: string;
            type: "String" | "Number" | "Money" | "Date";
            values?: string;
        }[];
        priority?: number;
        receiveDate: Date;
        reminderDate?: Date;
        retentionTime?: string;
        sender: string;
        state: "OPEN"
        | "COMPLETED";
        subject: string;
    }
    Index

    Properties

    _links? assignees completionDate? completionUser? context? correlationKey? description? dmsReferences? dueDate? id metadata? priority? receiveDate reminderDate? retentionTime? sender state subject

    Properties

    Optional_links

    _links?: {
        attachment?: { href: string };
        form?: { href: string };
        self: { 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.

    • Optionalform?: { href: string }

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

    • self: { href: string }

      Link to this task.

    assignees: string[]

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

    completionDate?: Date

    Time at which the task was completed. Only present if completed

    completionUser?: string

    ID of the user that completed this task. Only present if completed

    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

    dmsReferences?: { objectId: string; repoId: string }[]

    DmsObject that references the task.

    Type Declaration

    • objectId: string

      ID of the DmsObject

    • repoId: 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.

    id: string

    Unique id of the task

    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

    • key: string

      A technical identifier for the metadata-field

    • type: "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)

    receiveDate: Date

    Receive date

    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.

    sender: string

    Sender of the task

    state: "OPEN" | "COMPLETED"

    State of the task

    subject: string

    The subject of the task

    Settings

    Member Visibility

    On This Page

    Properties