Skip to content

Links

LinkCategory

Bases: str, Enum

Attributes:

Name Type Description
MENTION
LINKED_TASK
SYNTHESIS
LINKED_INVENTORY

MENTION 

MENTION = 'mention'

LINKED_TASK 

LINKED_TASK = 'linkedTask'

SYNTHESIS 

SYNTHESIS = 'synthesis'

LINKED_INVENTORY 

LINKED_INVENTORY = 'linkedInventory'

Bases: BaseResource

A link in Albert.

Attributes:

Name Type Description
parent EntityLink

The parent entity of the link.
child EntityLink

The child entity of the link.
category LinkCategory

The category of the link. Allowed values are mention, linkedTask, and synthesis.
id str | None

The Albert ID of the link. Set when the link is retrieved from Albert.
counter int | None

The counter of the link. Optional.
Show JSON schema: 
{
  "$defs": {
    "AuditFields": {
      "description": "The audit fields for a resource",
      "properties": {
        "by": {
          "default": null,
          "title": "By",
          "type": "string"
        },
        "byName": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Byname"
        },
        "at": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "At"
        }
      },
      "title": "AuditFields",
      "type": "object"
    },
    "EntityLink": {
      "properties": {
        "id": {
          "title": "Id",
          "type": "string"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        }
      },
      "required": [
        "id"
      ],
      "title": "EntityLink",
      "type": "object"
    },
    "LinkCategory": {
      "enum": [
        "mention",
        "linkedTask",
        "synthesis",
        "linkedInventory"
      ],
      "title": "LinkCategory",
      "type": "string"
    },
    "Status": {
      "description": "The status of a resource",
      "enum": [
        "active",
        "inactive"
      ],
      "title": "Status",
      "type": "string"
    }
  },
  "description": "A link in Albert.\n\nAttributes\n----------\nparent : EntityLink\n    The parent entity of the link.\nchild : EntityLink\n    The child entity of the link.\ncategory : LinkCategory\n    The category of the link. Allowed values are `mention`, `linkedTask`, and `synthesis`.\nid : str | None\n    The Albert ID of the link. Set when the link is retrieved from Albert.\ncounter : int | None\n    The counter of the link. Optional.",
  "properties": {
    "status": {
      "anyOf": [
        {
          "$ref": "#/$defs/Status"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "Created": {
      "anyOf": [
        {
          "$ref": "#/$defs/AuditFields"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "Updated": {
      "anyOf": [
        {
          "$ref": "#/$defs/AuditFields"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "Parent": {
      "$ref": "#/$defs/EntityLink"
    },
    "Child": {
      "$ref": "#/$defs/EntityLink"
    },
    "category": {
      "$ref": "#/$defs/LinkCategory"
    },
    "counter": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Counter"
    },
    "albertId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Albertid"
    }
  },
  "required": [
    "Parent",
    "Child",
    "category"
  ],
  "title": "Link",
  "type": "object"
}

Fields:

parent 

parent: EntityLink

child 

child: EntityLink

category 

category: LinkCategory

counter 

counter: int | None = None

id 

id: str | None = None