Class ActivityLinks

ActivityLinks implements the activity link functions via using the ActivityLink interface

Hierarchy

  • ActivityLinks

Implements

Properties

activityTypes linkTypes

Methods

add clone delete get remove

Properties

activityTypes

activityTypes: default<string, number>

Activity types to map string to number for internal use. Activity types available are: "null", "case", "inspection", "request", "workorder", "wipcase"

linkTypes

linkTypes: default<string, number>

Link types to map string to number for internal use. Link types available are: "null", "parent", "related"

Methods

add

  • Create a new activity link between two items.

    Returns

    Returns Promise object that represents a

    Parameters

    • source_type: string

      Source type as string. Options: "null", "case", "inspection", "request", "workorder", "wipcase"

    • source_sid: number

      Source SID (numeric ID) one wishes to remove a link between SID as source and a particular destination

    • destination_type: string

      Destination type as string: "null", "case", "inspection", "request", "workorder", "wipcase"

    • destination_sid: number

      Destination SID (numeric ID) one wishes to remove a link between SID as destination and a particular source

    • link_type: string = 'related'

      The type of link which exists between provided source and destination. Defaults to related. Options: "null", "parent", "related"

    Returns Promise<unknown>

clone

  • Clone a current activity link.

    Returns

    Returns Promise object that represents a

    Parameters

    • source_type: string

      Source type as string. Options: "null", "case", "inspection", "request", "workorder", "wipcase"

    • source_sid: number

      Source SID (numeric ID) one wishes to clone a link between SID as source and a particular destination

    • destination_type: string

      Destination type as string: "null", "case", "inspection", "request", "workorder", "wipcase"

    • destination_sid: number

      Destination SID (numeric ID) one wishes to clone a link between SID as destination and a particular source

    Returns Promise<unknown>

delete

  • Delete an activity link by ID

    Returns

    Returns Promise object that represents a

    Parameters

    • activity_link_id: number

      The ID of the activity link one wishes to delete

    Returns Promise<unknown>

get

  • Get the links for a particular node type by ID.

    Returns

    Returns Promise object that represents a collection

    Parameters

    • type: string

      Source type as string. Options: "null", "case", "inspection", "request", "workorder", "wipcase"

    • sids: number[]

      Array of numeric (S)IDs you wish to get of the specified type

    Returns Promise<unknown>

remove

  • Remove a link by specifying everything.

    Returns

    Returns Promise object that represents a

    Parameters

    • source_type: string

      Source type as string. Options: "null", "case", "inspection", "request", "workorder", "wipcase"

    • source_sid: number

      Source SID (numeric ID) one wishes to remove a link between SID as source and a particular destination

    • destination_type: string

      Destination type as string: "null", "case", "inspection", "request", "workorder", "wipcase"

    • destination_sid: number

      Destination SID (numeric ID) one wishes to remove a link between SID as destination and a particular source

    • link_type: string = 'related'

      The type of link which exists between provided source and destination. Defaults to related. Options: "null", "parent", "related"

    Returns Promise<unknown>

Settings

Member Visibility

Theme